s4:heimdal: import lorikeet-heimdal-200909210500 (commit 290db8d23647a27c39b97c189a0b...
[Samba.git] / source4 / heimdal / lib / krb5 / store.c
blob6e1374adf9ab4012c15a8f3fd92fbb7c929e07c5
1 /*
2 * Copyright (c) 1997-2008 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
34 #include "krb5_locl.h"
35 #include "store-int.h"
37 #define BYTEORDER_IS(SP, V) (((SP)->flags & KRB5_STORAGE_BYTEORDER_MASK) == (V))
38 #define BYTEORDER_IS_LE(SP) BYTEORDER_IS((SP), KRB5_STORAGE_BYTEORDER_LE)
39 #define BYTEORDER_IS_BE(SP) BYTEORDER_IS((SP), KRB5_STORAGE_BYTEORDER_BE)
40 #define BYTEORDER_IS_HOST(SP) (BYTEORDER_IS((SP), KRB5_STORAGE_BYTEORDER_HOST) || \
41 krb5_storage_is_flags((SP), KRB5_STORAGE_HOST_BYTEORDER))
43 /**
44 * Add the flags on a storage buffer by or-ing in the flags to the buffer.
46 * @param sp the storage buffer to set the flags on
47 * @param flags the flags to set
49 * @ingroup krb5_storage
52 void KRB5_LIB_FUNCTION
53 krb5_storage_set_flags(krb5_storage *sp, krb5_flags flags)
55 sp->flags |= flags;
58 /**
59 * Clear the flags on a storage buffer
61 * @param sp the storage buffer to clear the flags on
62 * @param flags the flags to clear
64 * @ingroup krb5_storage
67 void KRB5_LIB_FUNCTION
68 krb5_storage_clear_flags(krb5_storage *sp, krb5_flags flags)
70 sp->flags &= ~flags;
73 /**
74 * Return true or false depending on if the storage flags is set or
75 * not. NB testing for the flag 0 always return true.
77 * @param sp the storage buffer to check flags on
78 * @param flags The flags to test for
80 * @return true if all the flags are set, false if not.
82 * @ingroup krb5_storage
85 krb5_boolean KRB5_LIB_FUNCTION
86 krb5_storage_is_flags(krb5_storage *sp, krb5_flags flags)
88 return (sp->flags & flags) == flags;
91 /**
92 * Set the new byte order of the storage buffer.
94 * @param sp the storage buffer to set the byte order for.
95 * @param byteorder the new byte order.
97 * The byte order are: KRB5_STORAGE_BYTEORDER_BE,
98 * KRB5_STORAGE_BYTEORDER_LE and KRB5_STORAGE_BYTEORDER_HOST.
100 * @ingroup krb5_storage
103 void KRB5_LIB_FUNCTION
104 krb5_storage_set_byteorder(krb5_storage *sp, krb5_flags byteorder)
106 sp->flags &= ~KRB5_STORAGE_BYTEORDER_MASK;
107 sp->flags |= byteorder;
111 * Return the current byteorder for the buffer. See krb5_storage_set_byteorder() for the list or byte order contants.
113 * @ingroup krb5_storage
116 krb5_flags KRB5_LIB_FUNCTION
117 krb5_storage_get_byteorder(krb5_storage *sp)
119 return sp->flags & KRB5_STORAGE_BYTEORDER_MASK;
123 * Seek to a new offset.
125 * @param sp the storage buffer to seek in.
126 * @param offset the offset to seek
127 * @param whence relateive searching, SEEK_CUR from the current
128 * position, SEEK_END from the end, SEEK_SET absolute from the start.
130 * @return The new current offset
132 * @ingroup krb5_storage
135 off_t KRB5_LIB_FUNCTION
136 krb5_storage_seek(krb5_storage *sp, off_t offset, int whence)
138 return (*sp->seek)(sp, offset, whence);
142 * Truncate the storage buffer in sp to offset.
144 * @param sp the storage buffer to truncate.
145 * @param offset the offset to truncate too.
147 * @return An Kerberos 5 error code.
149 * @ingroup krb5_storage
152 int KRB5_LIB_FUNCTION
153 krb5_storage_truncate(krb5_storage *sp, off_t offset)
155 return (*sp->trunc)(sp, offset);
159 * Read to the storage buffer.
161 * @param sp the storage buffer to read from
162 * @param buf the buffer to store the data in
163 * @param len the length to read
165 * @return The length of data read (can be shorter then len), or negative on error.
167 * @ingroup krb5_storage
170 krb5_ssize_t KRB5_LIB_FUNCTION
171 krb5_storage_read(krb5_storage *sp, void *buf, size_t len)
173 return sp->fetch(sp, buf, len);
177 * Write to the storage buffer.
179 * @param sp the storage buffer to write to
180 * @param buf the buffer to write to the storage buffer
181 * @param len the length to write
183 * @return The length of data written (can be shorter then len), or negative on error.
185 * @ingroup krb5_storage
188 krb5_ssize_t KRB5_LIB_FUNCTION
189 krb5_storage_write(krb5_storage *sp, const void *buf, size_t len)
191 return sp->store(sp, buf, len);
195 * Set the return code that will be used when end of storage is reached.
197 * @param sp the storage
198 * @param code the error code to return on end of storage
200 * @ingroup krb5_storage
203 void KRB5_LIB_FUNCTION
204 krb5_storage_set_eof_code(krb5_storage *sp, int code)
206 sp->eof_code = code;
210 * Get the return code that will be used when end of storage is reached.
212 * @param sp the storage
214 * @return storage error code
216 * @ingroup krb5_storage
219 int KRB5_LIB_FUNCTION
220 krb5_storage_get_eof_code(krb5_storage *sp)
222 return sp->eof_code;
225 krb5_ssize_t KRB5_LIB_FUNCTION
226 _krb5_put_int(void *buffer, unsigned long value, size_t size)
228 unsigned char *p = buffer;
229 int i;
230 for (i = size - 1; i >= 0; i--) {
231 p[i] = value & 0xff;
232 value >>= 8;
234 return size;
237 krb5_ssize_t KRB5_LIB_FUNCTION
238 _krb5_get_int(void *buffer, unsigned long *value, size_t size)
240 unsigned char *p = buffer;
241 unsigned long v = 0;
242 int i;
243 for (i = 0; i < size; i++)
244 v = (v << 8) + p[i];
245 *value = v;
246 return size;
250 * Free a krb5 storage.
252 * @param sp the storage to free.
254 * @return An Kerberos 5 error code.
256 * @ingroup krb5_storage
259 krb5_error_code KRB5_LIB_FUNCTION
260 krb5_storage_free(krb5_storage *sp)
262 if(sp->free)
263 (*sp->free)(sp);
264 free(sp->data);
265 free(sp);
266 return 0;
270 * Copy the contnent of storage
272 * @param sp the storage to copy to a data
273 * @param data the copied data, free with krb5_data_free()
275 * @return 0 for success, or a Kerberos 5 error code on failure.
277 * @ingroup krb5_storage
280 krb5_error_code KRB5_LIB_FUNCTION
281 krb5_storage_to_data(krb5_storage *sp, krb5_data *data)
283 off_t pos, size;
284 krb5_error_code ret;
286 pos = sp->seek(sp, 0, SEEK_CUR);
287 if (pos < 0)
288 return HEIM_ERR_NOT_SEEKABLE;
289 size = (size_t)sp->seek(sp, 0, SEEK_END);
290 if (size > (size_t)-1)
291 return HEIM_ERR_TOO_BIG;
292 ret = krb5_data_alloc (data, size);
293 if (ret) {
294 sp->seek(sp, pos, SEEK_SET);
295 return ret;
297 if (size) {
298 sp->seek(sp, 0, SEEK_SET);
299 sp->fetch(sp, data->data, data->length);
300 sp->seek(sp, pos, SEEK_SET);
302 return 0;
305 static krb5_error_code
306 krb5_store_int(krb5_storage *sp,
307 int32_t value,
308 size_t len)
310 int ret;
311 unsigned char v[16];
313 if(len > sizeof(v))
314 return EINVAL;
315 _krb5_put_int(v, value, len);
316 ret = sp->store(sp, v, len);
317 if (ret != len)
318 return (ret<0)?errno:sp->eof_code;
319 return 0;
323 * Store a int32 to storage, byte order is controlled by the settings
324 * on the storage, see krb5_storage_set_byteorder().
326 * @param sp the storage to write too
327 * @param value the value to store
329 * @return 0 for success, or a Kerberos 5 error code on failure.
331 * @ingroup krb5_storage
334 krb5_error_code KRB5_LIB_FUNCTION
335 krb5_store_int32(krb5_storage *sp,
336 int32_t value)
338 if(BYTEORDER_IS_HOST(sp))
339 value = htonl(value);
340 else if(BYTEORDER_IS_LE(sp))
341 value = bswap32(value);
342 return krb5_store_int(sp, value, 4);
346 * Store a uint32 to storage, byte order is controlled by the settings
347 * on the storage, see krb5_storage_set_byteorder().
349 * @param sp the storage to write too
350 * @param value the value to store
352 * @return 0 for success, or a Kerberos 5 error code on failure.
354 * @ingroup krb5_storage
357 krb5_error_code KRB5_LIB_FUNCTION
358 krb5_store_uint32(krb5_storage *sp,
359 uint32_t value)
361 return krb5_store_int32(sp, (int32_t)value);
364 static krb5_error_code
365 krb5_ret_int(krb5_storage *sp,
366 int32_t *value,
367 size_t len)
369 int ret;
370 unsigned char v[4];
371 unsigned long w;
372 ret = sp->fetch(sp, v, len);
373 if(ret != len)
374 return (ret<0)?errno:sp->eof_code;
375 _krb5_get_int(v, &w, len);
376 *value = w;
377 return 0;
381 * Read a int32 from storage, byte order is controlled by the settings
382 * on the storage, see krb5_storage_set_byteorder().
384 * @param sp the storage to write too
385 * @param value the value read from the buffer
387 * @return 0 for success, or a Kerberos 5 error code on failure.
389 * @ingroup krb5_storage
392 krb5_error_code KRB5_LIB_FUNCTION
393 krb5_ret_int32(krb5_storage *sp,
394 int32_t *value)
396 krb5_error_code ret = krb5_ret_int(sp, value, 4);
397 if(ret)
398 return ret;
399 if(BYTEORDER_IS_HOST(sp))
400 *value = htonl(*value);
401 else if(BYTEORDER_IS_LE(sp))
402 *value = bswap32(*value);
403 return 0;
407 * Read a uint32 from storage, byte order is controlled by the settings
408 * on the storage, see krb5_storage_set_byteorder().
410 * @param sp the storage to write too
411 * @param value the value read from the buffer
413 * @return 0 for success, or a Kerberos 5 error code on failure.
415 * @ingroup krb5_storage
418 krb5_error_code KRB5_LIB_FUNCTION
419 krb5_ret_uint32(krb5_storage *sp,
420 uint32_t *value)
422 krb5_error_code ret;
423 int32_t v;
425 ret = krb5_ret_int32(sp, &v);
426 if (ret == 0)
427 *value = (uint32_t)v;
429 return ret;
433 * Store a int16 to storage, byte order is controlled by the settings
434 * on the storage, see krb5_storage_set_byteorder().
436 * @param sp the storage to write too
437 * @param value the value to store
439 * @return 0 for success, or a Kerberos 5 error code on failure.
441 * @ingroup krb5_storage
444 krb5_error_code KRB5_LIB_FUNCTION
445 krb5_store_int16(krb5_storage *sp,
446 int16_t value)
448 if(BYTEORDER_IS_HOST(sp))
449 value = htons(value);
450 else if(BYTEORDER_IS_LE(sp))
451 value = bswap16(value);
452 return krb5_store_int(sp, value, 2);
456 * Store a uint16 to storage, byte order is controlled by the settings
457 * on the storage, see krb5_storage_set_byteorder().
459 * @param sp the storage to write too
460 * @param value the value to store
462 * @return 0 for success, or a Kerberos 5 error code on failure.
464 * @ingroup krb5_storage
467 krb5_error_code KRB5_LIB_FUNCTION
468 krb5_store_uint16(krb5_storage *sp,
469 uint16_t value)
471 return krb5_store_int16(sp, (int16_t)value);
475 * Read a int16 from storage, byte order is controlled by the settings
476 * on the storage, see krb5_storage_set_byteorder().
478 * @param sp the storage to write too
479 * @param value the value read from the buffer
481 * @return 0 for success, or a Kerberos 5 error code on failure.
483 * @ingroup krb5_storage
485 krb5_error_code KRB5_LIB_FUNCTION
486 krb5_ret_int16(krb5_storage *sp,
487 int16_t *value)
489 int32_t v;
490 int ret;
491 ret = krb5_ret_int(sp, &v, 2);
492 if(ret)
493 return ret;
494 *value = v;
495 if(BYTEORDER_IS_HOST(sp))
496 *value = htons(*value);
497 else if(BYTEORDER_IS_LE(sp))
498 *value = bswap16(*value);
499 return 0;
503 * Read a int16 from storage, byte order is controlled by the settings
504 * on the storage, see krb5_storage_set_byteorder().
506 * @param sp the storage to write too
507 * @param value the value read from the buffer
509 * @return 0 for success, or a Kerberos 5 error code on failure.
511 * @ingroup krb5_storage
514 krb5_error_code KRB5_LIB_FUNCTION
515 krb5_ret_uint16(krb5_storage *sp,
516 uint16_t *value)
518 krb5_error_code ret;
519 int16_t v;
521 ret = krb5_ret_int16(sp, &v);
522 if (ret == 0)
523 *value = (uint16_t)v;
525 return ret;
529 * Store a int8 to storage.
531 * @param sp the storage to write too
532 * @param value the value to store
534 * @return 0 for success, or a Kerberos 5 error code on failure.
536 * @ingroup krb5_storage
539 krb5_error_code KRB5_LIB_FUNCTION
540 krb5_store_int8(krb5_storage *sp,
541 int8_t value)
543 int ret;
545 ret = sp->store(sp, &value, sizeof(value));
546 if (ret != sizeof(value))
547 return (ret<0)?errno:sp->eof_code;
548 return 0;
552 * Store a uint8 to storage.
554 * @param sp the storage to write too
555 * @param value the value to store
557 * @return 0 for success, or a Kerberos 5 error code on failure.
559 * @ingroup krb5_storage
562 krb5_error_code KRB5_LIB_FUNCTION
563 krb5_store_uint8(krb5_storage *sp,
564 uint8_t value)
566 return krb5_store_int8(sp, (int8_t)value);
570 * Read a int8 from storage
572 * @param sp the storage to write too
573 * @param value the value read from the buffer
575 * @return 0 for success, or a Kerberos 5 error code on failure.
577 * @ingroup krb5_storage
580 krb5_error_code KRB5_LIB_FUNCTION
581 krb5_ret_int8(krb5_storage *sp,
582 int8_t *value)
584 int ret;
586 ret = sp->fetch(sp, value, sizeof(*value));
587 if (ret != sizeof(*value))
588 return (ret<0)?errno:sp->eof_code;
589 return 0;
593 * Read a uint8 from storage
595 * @param sp the storage to write too
596 * @param value the value read from the buffer
598 * @return 0 for success, or a Kerberos 5 error code on failure.
600 * @ingroup krb5_storage
603 krb5_error_code KRB5_LIB_FUNCTION
604 krb5_ret_uint8(krb5_storage *sp,
605 uint8_t *value)
607 krb5_error_code ret;
608 int8_t v;
610 ret = krb5_ret_int8(sp, &v);
611 if (ret == 0)
612 *value = (uint8_t)v;
614 return ret;
618 * Store a data to the storage. The data is stored with an int32 as
619 * lenght plus the data (not padded).
621 * @param sp the storage buffer to write to
622 * @param data the buffer to store.
624 * @return 0 on success, a Kerberos 5 error code on failure.
626 * @ingroup krb5_storage
629 krb5_error_code KRB5_LIB_FUNCTION
630 krb5_store_data(krb5_storage *sp,
631 krb5_data data)
633 int ret;
634 ret = krb5_store_int32(sp, data.length);
635 if(ret < 0)
636 return ret;
637 ret = sp->store(sp, data.data, data.length);
638 if(ret != data.length){
639 if(ret < 0)
640 return errno;
641 return sp->eof_code;
643 return 0;
647 * Parse a data from the storage.
649 * @param sp the storage buffer to read from
650 * @param data the parsed data
652 * @return 0 on success, a Kerberos 5 error code on failure.
654 * @ingroup krb5_storage
657 krb5_error_code KRB5_LIB_FUNCTION
658 krb5_ret_data(krb5_storage *sp,
659 krb5_data *data)
661 int ret;
662 int32_t size;
664 ret = krb5_ret_int32(sp, &size);
665 if(ret)
666 return ret;
667 ret = krb5_data_alloc (data, size);
668 if (ret)
669 return ret;
670 if (size) {
671 ret = sp->fetch(sp, data->data, size);
672 if(ret != size)
673 return (ret < 0)? errno : sp->eof_code;
675 return 0;
679 * Store a string to the buffer. The data is formated as an len:uint32
680 * plus the string itself (not padded).
682 * @param sp the storage buffer to write to
683 * @param s the string to store.
685 * @return 0 on success, a Kerberos 5 error code on failure.
687 * @ingroup krb5_storage
690 krb5_error_code KRB5_LIB_FUNCTION
691 krb5_store_string(krb5_storage *sp, const char *s)
693 krb5_data data;
694 data.length = strlen(s);
695 data.data = rk_UNCONST(s);
696 return krb5_store_data(sp, data);
700 * Parse a string from the storage.
702 * @param sp the storage buffer to read from
703 * @param string the parsed string
705 * @return 0 on success, a Kerberos 5 error code on failure.
707 * @ingroup krb5_storage
711 krb5_error_code KRB5_LIB_FUNCTION
712 krb5_ret_string(krb5_storage *sp,
713 char **string)
715 int ret;
716 krb5_data data;
717 ret = krb5_ret_data(sp, &data);
718 if(ret)
719 return ret;
720 *string = realloc(data.data, data.length + 1);
721 if(*string == NULL){
722 free(data.data);
723 return ENOMEM;
725 (*string)[data.length] = 0;
726 return 0;
730 * Store a zero terminated string to the buffer. The data is stored
731 * one character at a time until a NUL is stored.
733 * @param sp the storage buffer to write to
734 * @param s the string to store.
736 * @return 0 on success, a Kerberos 5 error code on failure.
738 * @ingroup krb5_storage
741 krb5_error_code KRB5_LIB_FUNCTION
742 krb5_store_stringz(krb5_storage *sp, const char *s)
744 size_t len = strlen(s) + 1;
745 ssize_t ret;
747 ret = sp->store(sp, s, len);
748 if(ret != len) {
749 if(ret < 0)
750 return ret;
751 else
752 return sp->eof_code;
754 return 0;
758 * Parse zero terminated string from the storage.
760 * @param sp the storage buffer to read from
761 * @param string the parsed string
763 * @return 0 on success, a Kerberos 5 error code on failure.
765 * @ingroup krb5_storage
768 krb5_error_code KRB5_LIB_FUNCTION
769 krb5_ret_stringz(krb5_storage *sp,
770 char **string)
772 char c;
773 char *s = NULL;
774 size_t len = 0;
775 ssize_t ret;
777 while((ret = sp->fetch(sp, &c, 1)) == 1){
778 char *tmp;
780 len++;
781 tmp = realloc (s, len);
782 if (tmp == NULL) {
783 free (s);
784 return ENOMEM;
786 s = tmp;
787 s[len - 1] = c;
788 if(c == 0)
789 break;
791 if(ret != 1){
792 free(s);
793 if(ret == 0)
794 return sp->eof_code;
795 return ret;
797 *string = s;
798 return 0;
801 krb5_error_code KRB5_LIB_FUNCTION
802 krb5_store_stringnl(krb5_storage *sp, const char *s)
804 size_t len = strlen(s);
805 ssize_t ret;
807 ret = sp->store(sp, s, len);
808 if(ret != len) {
809 if(ret < 0)
810 return ret;
811 else
812 return sp->eof_code;
814 ret = sp->store(sp, "\n", 1);
815 if(ret != 1) {
816 if(ret < 0)
817 return ret;
818 else
819 return sp->eof_code;
822 return 0;
826 krb5_error_code KRB5_LIB_FUNCTION
827 krb5_ret_stringnl(krb5_storage *sp,
828 char **string)
830 int expect_nl = 0;
831 char c;
832 char *s = NULL;
833 size_t len = 0;
834 ssize_t ret;
836 while((ret = sp->fetch(sp, &c, 1)) == 1){
837 char *tmp;
839 if (c == '\r') {
840 expect_nl = 1;
841 continue;
843 if (expect_nl && c != '\n') {
844 free(s);
845 return KRB5_BADMSGTYPE;
848 len++;
849 tmp = realloc (s, len);
850 if (tmp == NULL) {
851 free (s);
852 return ENOMEM;
854 s = tmp;
855 if(c == '\n') {
856 s[len - 1] = '\0';
857 break;
859 s[len - 1] = c;
861 if(ret != 1){
862 free(s);
863 if(ret == 0)
864 return sp->eof_code;
865 return ret;
867 *string = s;
868 return 0;
872 * Write a principal block to storage.
874 * @param sp the storage buffer to write to
875 * @param p the principal block to write.
877 * @return 0 on success, a Kerberos 5 error code on failure.
879 * @ingroup krb5_storage
882 krb5_error_code KRB5_LIB_FUNCTION
883 krb5_store_principal(krb5_storage *sp,
884 krb5_const_principal p)
886 int i;
887 int ret;
889 if(!krb5_storage_is_flags(sp, KRB5_STORAGE_PRINCIPAL_NO_NAME_TYPE)) {
890 ret = krb5_store_int32(sp, p->name.name_type);
891 if(ret) return ret;
893 if(krb5_storage_is_flags(sp, KRB5_STORAGE_PRINCIPAL_WRONG_NUM_COMPONENTS))
894 ret = krb5_store_int32(sp, p->name.name_string.len + 1);
895 else
896 ret = krb5_store_int32(sp, p->name.name_string.len);
898 if(ret) return ret;
899 ret = krb5_store_string(sp, p->realm);
900 if(ret) return ret;
901 for(i = 0; i < p->name.name_string.len; i++){
902 ret = krb5_store_string(sp, p->name.name_string.val[i]);
903 if(ret) return ret;
905 return 0;
909 * Parse principal from the storage.
911 * @param sp the storage buffer to read from
912 * @param princ the parsed principal
914 * @return 0 on success, a Kerberos 5 error code on failure.
916 * @ingroup krb5_storage
919 krb5_error_code KRB5_LIB_FUNCTION
920 krb5_ret_principal(krb5_storage *sp,
921 krb5_principal *princ)
923 int i;
924 int ret;
925 krb5_principal p;
926 int32_t type;
927 int32_t ncomp;
929 p = calloc(1, sizeof(*p));
930 if(p == NULL)
931 return ENOMEM;
933 if(krb5_storage_is_flags(sp, KRB5_STORAGE_PRINCIPAL_NO_NAME_TYPE))
934 type = KRB5_NT_UNKNOWN;
935 else if((ret = krb5_ret_int32(sp, &type))){
936 free(p);
937 return ret;
939 if((ret = krb5_ret_int32(sp, &ncomp))){
940 free(p);
941 return ret;
943 if(krb5_storage_is_flags(sp, KRB5_STORAGE_PRINCIPAL_WRONG_NUM_COMPONENTS))
944 ncomp--;
945 if (ncomp < 0) {
946 free(p);
947 return EINVAL;
949 p->name.name_type = type;
950 p->name.name_string.len = ncomp;
951 ret = krb5_ret_string(sp, &p->realm);
952 if(ret) {
953 free(p);
954 return ret;
956 p->name.name_string.val = calloc(ncomp, sizeof(*p->name.name_string.val));
957 if(p->name.name_string.val == NULL && ncomp != 0){
958 free(p->realm);
959 free(p);
960 return ENOMEM;
962 for(i = 0; i < ncomp; i++){
963 ret = krb5_ret_string(sp, &p->name.name_string.val[i]);
964 if(ret) {
965 while (i >= 0)
966 free(p->name.name_string.val[i--]);
967 free(p->realm);
968 free(p);
969 return ret;
972 *princ = p;
973 return 0;
977 * Store a keyblock to the storage.
979 * @param sp the storage buffer to write to
980 * @param p the keyblock to write
982 * @return 0 on success, a Kerberos 5 error code on failure.
984 * @ingroup krb5_storage
987 krb5_error_code KRB5_LIB_FUNCTION
988 krb5_store_keyblock(krb5_storage *sp, krb5_keyblock p)
990 int ret;
991 ret = krb5_store_int16(sp, p.keytype);
992 if(ret) return ret;
994 if(krb5_storage_is_flags(sp, KRB5_STORAGE_KEYBLOCK_KEYTYPE_TWICE)){
995 /* this should really be enctype, but it is the same as
996 keytype nowadays */
997 ret = krb5_store_int16(sp, p.keytype);
998 if(ret) return ret;
1001 ret = krb5_store_data(sp, p.keyvalue);
1002 return ret;
1006 * Read a keyblock from the storage.
1008 * @param sp the storage buffer to write to
1009 * @param p the keyblock read from storage, free using krb5_free_keyblock()
1011 * @return 0 on success, a Kerberos 5 error code on failure.
1013 * @ingroup krb5_storage
1016 krb5_error_code KRB5_LIB_FUNCTION
1017 krb5_ret_keyblock(krb5_storage *sp, krb5_keyblock *p)
1019 int ret;
1020 int16_t tmp;
1022 ret = krb5_ret_int16(sp, &tmp);
1023 if(ret) return ret;
1024 p->keytype = tmp;
1026 if(krb5_storage_is_flags(sp, KRB5_STORAGE_KEYBLOCK_KEYTYPE_TWICE)){
1027 ret = krb5_ret_int16(sp, &tmp);
1028 if(ret) return ret;
1031 ret = krb5_ret_data(sp, &p->keyvalue);
1032 return ret;
1036 * Write a times block to storage.
1038 * @param sp the storage buffer to write to
1039 * @param times the times block to write.
1041 * @return 0 on success, a Kerberos 5 error code on failure.
1043 * @ingroup krb5_storage
1046 krb5_error_code KRB5_LIB_FUNCTION
1047 krb5_store_times(krb5_storage *sp, krb5_times times)
1049 int ret;
1050 ret = krb5_store_int32(sp, times.authtime);
1051 if(ret) return ret;
1052 ret = krb5_store_int32(sp, times.starttime);
1053 if(ret) return ret;
1054 ret = krb5_store_int32(sp, times.endtime);
1055 if(ret) return ret;
1056 ret = krb5_store_int32(sp, times.renew_till);
1057 return ret;
1061 * Read a times block from the storage.
1063 * @param sp the storage buffer to write to
1064 * @param times the times block read from storage
1066 * @return 0 on success, a Kerberos 5 error code on failure.
1068 * @ingroup krb5_storage
1071 krb5_error_code KRB5_LIB_FUNCTION
1072 krb5_ret_times(krb5_storage *sp, krb5_times *times)
1074 int ret;
1075 int32_t tmp;
1076 ret = krb5_ret_int32(sp, &tmp);
1077 times->authtime = tmp;
1078 if(ret) return ret;
1079 ret = krb5_ret_int32(sp, &tmp);
1080 times->starttime = tmp;
1081 if(ret) return ret;
1082 ret = krb5_ret_int32(sp, &tmp);
1083 times->endtime = tmp;
1084 if(ret) return ret;
1085 ret = krb5_ret_int32(sp, &tmp);
1086 times->renew_till = tmp;
1087 return ret;
1091 * Write a address block to storage.
1093 * @param sp the storage buffer to write to
1094 * @param p the address block to write.
1096 * @return 0 on success, a Kerberos 5 error code on failure.
1098 * @ingroup krb5_storage
1101 krb5_error_code KRB5_LIB_FUNCTION
1102 krb5_store_address(krb5_storage *sp, krb5_address p)
1104 int ret;
1105 ret = krb5_store_int16(sp, p.addr_type);
1106 if(ret) return ret;
1107 ret = krb5_store_data(sp, p.address);
1108 return ret;
1112 * Read a address block from the storage.
1114 * @param sp the storage buffer to write to
1115 * @param adr the address block read from storage
1117 * @return 0 on success, a Kerberos 5 error code on failure.
1119 * @ingroup krb5_storage
1122 krb5_error_code KRB5_LIB_FUNCTION
1123 krb5_ret_address(krb5_storage *sp, krb5_address *adr)
1125 int16_t t;
1126 int ret;
1127 ret = krb5_ret_int16(sp, &t);
1128 if(ret) return ret;
1129 adr->addr_type = t;
1130 ret = krb5_ret_data(sp, &adr->address);
1131 return ret;
1135 * Write a addresses block to storage.
1137 * @param sp the storage buffer to write to
1138 * @param p the addresses block to write.
1140 * @return 0 on success, a Kerberos 5 error code on failure.
1142 * @ingroup krb5_storage
1145 krb5_error_code KRB5_LIB_FUNCTION
1146 krb5_store_addrs(krb5_storage *sp, krb5_addresses p)
1148 int i;
1149 int ret;
1150 ret = krb5_store_int32(sp, p.len);
1151 if(ret) return ret;
1152 for(i = 0; i<p.len; i++){
1153 ret = krb5_store_address(sp, p.val[i]);
1154 if(ret) break;
1156 return ret;
1160 * Read a addresses block from the storage.
1162 * @param sp the storage buffer to write to
1163 * @param adr the addresses block read from storage
1165 * @return 0 on success, a Kerberos 5 error code on failure.
1167 * @ingroup krb5_storage
1170 krb5_error_code KRB5_LIB_FUNCTION
1171 krb5_ret_addrs(krb5_storage *sp, krb5_addresses *adr)
1173 int i;
1174 int ret;
1175 int32_t tmp;
1177 ret = krb5_ret_int32(sp, &tmp);
1178 if(ret) return ret;
1179 adr->len = tmp;
1180 ALLOC(adr->val, adr->len);
1181 if (adr->val == NULL && adr->len != 0)
1182 return ENOMEM;
1183 for(i = 0; i < adr->len; i++){
1184 ret = krb5_ret_address(sp, &adr->val[i]);
1185 if(ret) break;
1187 return ret;
1191 * Write a auth data block to storage.
1193 * @param sp the storage buffer to write to
1194 * @param auth the auth data block to write.
1196 * @return 0 on success, a Kerberos 5 error code on failure.
1198 * @ingroup krb5_storage
1201 krb5_error_code KRB5_LIB_FUNCTION
1202 krb5_store_authdata(krb5_storage *sp, krb5_authdata auth)
1204 krb5_error_code ret;
1205 int i;
1206 ret = krb5_store_int32(sp, auth.len);
1207 if(ret) return ret;
1208 for(i = 0; i < auth.len; i++){
1209 ret = krb5_store_int16(sp, auth.val[i].ad_type);
1210 if(ret) break;
1211 ret = krb5_store_data(sp, auth.val[i].ad_data);
1212 if(ret) break;
1214 return 0;
1218 * Read a auth data from the storage.
1220 * @param sp the storage buffer to write to
1221 * @param auth the auth data block read from storage
1223 * @return 0 on success, a Kerberos 5 error code on failure.
1225 * @ingroup krb5_storage
1228 krb5_error_code KRB5_LIB_FUNCTION
1229 krb5_ret_authdata(krb5_storage *sp, krb5_authdata *auth)
1231 krb5_error_code ret;
1232 int32_t tmp;
1233 int16_t tmp2;
1234 int i;
1235 ret = krb5_ret_int32(sp, &tmp);
1236 if(ret) return ret;
1237 ALLOC_SEQ(auth, tmp);
1238 if (auth->val == NULL && tmp != 0)
1239 return ENOMEM;
1240 for(i = 0; i < tmp; i++){
1241 ret = krb5_ret_int16(sp, &tmp2);
1242 if(ret) break;
1243 auth->val[i].ad_type = tmp2;
1244 ret = krb5_ret_data(sp, &auth->val[i].ad_data);
1245 if(ret) break;
1247 return ret;
1250 static int32_t
1251 bitswap32(int32_t b)
1253 int32_t r = 0;
1254 int i;
1255 for (i = 0; i < 32; i++) {
1256 r = r << 1 | (b & 1);
1257 b = b >> 1;
1259 return r;
1263 * Write a credentials block to storage.
1265 * @param sp the storage buffer to write to
1266 * @param creds the creds block to write.
1268 * @return 0 on success, a Kerberos 5 error code on failure.
1270 * @ingroup krb5_storage
1273 krb5_error_code KRB5_LIB_FUNCTION
1274 krb5_store_creds(krb5_storage *sp, krb5_creds *creds)
1276 int ret;
1278 ret = krb5_store_principal(sp, creds->client);
1279 if(ret)
1280 return ret;
1281 ret = krb5_store_principal(sp, creds->server);
1282 if(ret)
1283 return ret;
1284 ret = krb5_store_keyblock(sp, creds->session);
1285 if(ret)
1286 return ret;
1287 ret = krb5_store_times(sp, creds->times);
1288 if(ret)
1289 return ret;
1290 ret = krb5_store_int8(sp, creds->second_ticket.length != 0); /* is_skey */
1291 if(ret)
1292 return ret;
1294 if(krb5_storage_is_flags(sp, KRB5_STORAGE_CREDS_FLAGS_WRONG_BITORDER))
1295 ret = krb5_store_int32(sp, creds->flags.i);
1296 else
1297 ret = krb5_store_int32(sp, bitswap32(TicketFlags2int(creds->flags.b)));
1298 if(ret)
1299 return ret;
1301 ret = krb5_store_addrs(sp, creds->addresses);
1302 if(ret)
1303 return ret;
1304 ret = krb5_store_authdata(sp, creds->authdata);
1305 if(ret)
1306 return ret;
1307 ret = krb5_store_data(sp, creds->ticket);
1308 if(ret)
1309 return ret;
1310 ret = krb5_store_data(sp, creds->second_ticket);
1311 return ret;
1315 * Read a credentials block from the storage.
1317 * @param sp the storage buffer to write to
1318 * @param creds the credentials block read from storage
1320 * @return 0 on success, a Kerberos 5 error code on failure.
1322 * @ingroup krb5_storage
1325 krb5_error_code KRB5_LIB_FUNCTION
1326 krb5_ret_creds(krb5_storage *sp, krb5_creds *creds)
1328 krb5_error_code ret;
1329 int8_t dummy8;
1330 int32_t dummy32;
1332 memset(creds, 0, sizeof(*creds));
1333 ret = krb5_ret_principal (sp, &creds->client);
1334 if(ret) goto cleanup;
1335 ret = krb5_ret_principal (sp, &creds->server);
1336 if(ret) goto cleanup;
1337 ret = krb5_ret_keyblock (sp, &creds->session);
1338 if(ret) goto cleanup;
1339 ret = krb5_ret_times (sp, &creds->times);
1340 if(ret) goto cleanup;
1341 ret = krb5_ret_int8 (sp, &dummy8);
1342 if(ret) goto cleanup;
1343 ret = krb5_ret_int32 (sp, &dummy32);
1344 if(ret) goto cleanup;
1346 * Runtime detect the what is the higher bits of the bitfield. If
1347 * any of the higher bits are set in the input data, it's either a
1348 * new ticket flag (and this code need to be removed), or it's a
1349 * MIT cache (or new Heimdal cache), lets change it to our current
1350 * format.
1353 uint32_t mask = 0xffff0000;
1354 creds->flags.i = 0;
1355 creds->flags.b.anonymous = 1;
1356 if (creds->flags.i & mask)
1357 mask = ~mask;
1358 if (dummy32 & mask)
1359 dummy32 = bitswap32(dummy32);
1361 creds->flags.i = dummy32;
1362 ret = krb5_ret_addrs (sp, &creds->addresses);
1363 if(ret) goto cleanup;
1364 ret = krb5_ret_authdata (sp, &creds->authdata);
1365 if(ret) goto cleanup;
1366 ret = krb5_ret_data (sp, &creds->ticket);
1367 if(ret) goto cleanup;
1368 ret = krb5_ret_data (sp, &creds->second_ticket);
1369 cleanup:
1370 if(ret) {
1371 #if 0
1372 krb5_free_cred_contents(context, creds); /* XXX */
1373 #endif
1375 return ret;
1378 #define SC_CLIENT_PRINCIPAL 0x0001
1379 #define SC_SERVER_PRINCIPAL 0x0002
1380 #define SC_SESSION_KEY 0x0004
1381 #define SC_TICKET 0x0008
1382 #define SC_SECOND_TICKET 0x0010
1383 #define SC_AUTHDATA 0x0020
1384 #define SC_ADDRESSES 0x0040
1387 * Write a tagged credentials block to storage.
1389 * @param sp the storage buffer to write to
1390 * @param creds the creds block to write.
1392 * @return 0 on success, a Kerberos 5 error code on failure.
1394 * @ingroup krb5_storage
1397 krb5_error_code KRB5_LIB_FUNCTION
1398 krb5_store_creds_tag(krb5_storage *sp, krb5_creds *creds)
1400 int ret;
1401 int32_t header = 0;
1403 if (creds->client)
1404 header |= SC_CLIENT_PRINCIPAL;
1405 if (creds->server)
1406 header |= SC_SERVER_PRINCIPAL;
1407 if (creds->session.keytype != ETYPE_NULL)
1408 header |= SC_SESSION_KEY;
1409 if (creds->ticket.data)
1410 header |= SC_TICKET;
1411 if (creds->second_ticket.length)
1412 header |= SC_SECOND_TICKET;
1413 if (creds->authdata.len)
1414 header |= SC_AUTHDATA;
1415 if (creds->addresses.len)
1416 header |= SC_ADDRESSES;
1418 ret = krb5_store_int32(sp, header);
1419 if (ret)
1420 return ret;
1422 if (creds->client) {
1423 ret = krb5_store_principal(sp, creds->client);
1424 if(ret)
1425 return ret;
1428 if (creds->server) {
1429 ret = krb5_store_principal(sp, creds->server);
1430 if(ret)
1431 return ret;
1434 if (creds->session.keytype != ETYPE_NULL) {
1435 ret = krb5_store_keyblock(sp, creds->session);
1436 if(ret)
1437 return ret;
1440 ret = krb5_store_times(sp, creds->times);
1441 if(ret)
1442 return ret;
1443 ret = krb5_store_int8(sp, creds->second_ticket.length != 0); /* is_skey */
1444 if(ret)
1445 return ret;
1447 ret = krb5_store_int32(sp, bitswap32(TicketFlags2int(creds->flags.b)));
1448 if(ret)
1449 return ret;
1451 if (creds->addresses.len) {
1452 ret = krb5_store_addrs(sp, creds->addresses);
1453 if(ret)
1454 return ret;
1457 if (creds->authdata.len) {
1458 ret = krb5_store_authdata(sp, creds->authdata);
1459 if(ret)
1460 return ret;
1463 if (creds->ticket.data) {
1464 ret = krb5_store_data(sp, creds->ticket);
1465 if(ret)
1466 return ret;
1469 if (creds->second_ticket.data) {
1470 ret = krb5_store_data(sp, creds->second_ticket);
1471 if (ret)
1472 return ret;
1475 return ret;
1479 * Read a tagged credentials block from the storage.
1481 * @param sp the storage buffer to write to
1482 * @param creds the credentials block read from storage
1484 * @return 0 on success, a Kerberos 5 error code on failure.
1486 * @ingroup krb5_storage
1489 krb5_error_code KRB5_LIB_FUNCTION
1490 krb5_ret_creds_tag(krb5_storage *sp,
1491 krb5_creds *creds)
1493 krb5_error_code ret;
1494 int8_t dummy8;
1495 int32_t dummy32, header;
1497 memset(creds, 0, sizeof(*creds));
1499 ret = krb5_ret_int32 (sp, &header);
1500 if (ret) goto cleanup;
1502 if (header & SC_CLIENT_PRINCIPAL) {
1503 ret = krb5_ret_principal (sp, &creds->client);
1504 if(ret) goto cleanup;
1506 if (header & SC_SERVER_PRINCIPAL) {
1507 ret = krb5_ret_principal (sp, &creds->server);
1508 if(ret) goto cleanup;
1510 if (header & SC_SESSION_KEY) {
1511 ret = krb5_ret_keyblock (sp, &creds->session);
1512 if(ret) goto cleanup;
1514 ret = krb5_ret_times (sp, &creds->times);
1515 if(ret) goto cleanup;
1516 ret = krb5_ret_int8 (sp, &dummy8);
1517 if(ret) goto cleanup;
1518 ret = krb5_ret_int32 (sp, &dummy32);
1519 if(ret) goto cleanup;
1521 * Runtime detect the what is the higher bits of the bitfield. If
1522 * any of the higher bits are set in the input data, it's either a
1523 * new ticket flag (and this code need to be removed), or it's a
1524 * MIT cache (or new Heimdal cache), lets change it to our current
1525 * format.
1528 uint32_t mask = 0xffff0000;
1529 creds->flags.i = 0;
1530 creds->flags.b.anonymous = 1;
1531 if (creds->flags.i & mask)
1532 mask = ~mask;
1533 if (dummy32 & mask)
1534 dummy32 = bitswap32(dummy32);
1536 creds->flags.i = dummy32;
1537 if (header & SC_ADDRESSES) {
1538 ret = krb5_ret_addrs (sp, &creds->addresses);
1539 if(ret) goto cleanup;
1541 if (header & SC_AUTHDATA) {
1542 ret = krb5_ret_authdata (sp, &creds->authdata);
1543 if(ret) goto cleanup;
1545 if (header & SC_TICKET) {
1546 ret = krb5_ret_data (sp, &creds->ticket);
1547 if(ret) goto cleanup;
1549 if (header & SC_SECOND_TICKET) {
1550 ret = krb5_ret_data (sp, &creds->second_ticket);
1551 if(ret) goto cleanup;
1554 cleanup:
1555 if(ret) {
1556 #if 0
1557 krb5_free_cred_contents(context, creds); /* XXX */
1558 #endif
1560 return ret;