r21606: Implement escaping function for ldap RDN values
[jra/samba/.git] / source3 / lib / ldap_escape.c
1 /* 
2    Unix SMB/CIFS implementation.
3    ldap filter argument escaping
4
5    Copyright (C) 1998, 1999, 2000 Luke Howard <lukeh@padl.com>,
6    Copyright (C) 2003 Andrew Bartlett <abartlet@samba.org>
7
8   
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #include "includes.h"
25
26 /**
27  * Escape a parameter to an LDAP filter string, so they cannot contain
28  * embeded ( ) * or \ chars which may cause it not to parse correctly. 
29  *
30  * @param s The input string
31  *
32  * @return A string allocated with malloc(), containing the escaped string, 
33  * and to be free()ed by the caller.
34  **/
35
36 char *escape_ldap_string_alloc(const char *s)
37 {
38         size_t len = strlen(s)+1;
39         char *output = (char *)SMB_MALLOC(len);
40         const char *sub;
41         int i = 0;
42         char *p = output;
43
44         if (output == NULL) {
45                 return NULL;
46         }
47         
48         while (*s)
49         {
50                 switch (*s)
51                 {
52                 case '*':
53                         sub = "\\2a";
54                         break;
55                 case '(':
56                         sub = "\\28";
57                         break;
58                 case ')':
59                         sub = "\\29";
60                         break;
61                 case '\\':
62                         sub = "\\5c";
63                         break;
64                 default:
65                         sub = NULL;
66                         break;
67                 }
68                 
69                 if (sub) {
70                         len = len + 3;
71                         output = (char *)SMB_REALLOC(output, len);
72                         if (!output) { 
73                                 return NULL;
74                         }
75                         
76                         p = &output[i];
77                         strncpy (p, sub, 3);
78                         p += 3;
79                         i += 3;
80
81                 } else {
82                         *p = *s;
83                         p++;
84                         i++;
85                 }
86                 s++;
87         }
88         
89         *p = '\0';
90         return output;
91 }
92
93 char *escape_rdn_val_string_alloc(const char *s)
94 {
95         char *output, *p;
96
97         /* The maximum size of the escaped string can be twice the actual size */
98         output = (char *)SMB_MALLOC(2*strlen(s) + 1);
99
100         if (output == NULL) {
101                 return NULL;
102         }
103
104         p = output;
105         
106         while (*s)
107         {
108                 switch (*s)
109                 {
110                 case ',':
111                 case '=':
112                 case '+':
113                 case '<':
114                 case '>':
115                 case '#':
116                 case ';':
117                 case '\\':
118                 case '\"':
119                         *p++ = '\\';
120                         *p++ = *s;
121                         break;
122                 default:
123                         *p = *s;
124                         p++;
125                 }
126                 
127                 s++;
128         }
129         
130         *p = '\0';
131
132         /* resize the string to the actual final size */
133         output = (char *)SMB_REALLOC(output, strlen(output) + 1);
134         return output;
135 }