2 Unix SMB/CIFS implementation.
3 Filename utility functions.
4 Copyright (C) Tim Prouty 2009
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * XXX: This is temporary and there should be no callers of this outside of
23 * this file once smb_filename is plumbed through all path based operations.
24 * The one legitimate caller currently is smb_fname_str_dbg(), which this
25 * could be made static for.
27 NTSTATUS get_full_smb_filename(TALLOC_CTX *ctx,
28 const struct smb_filename *smb_fname,
31 if (smb_fname->stream_name) {
32 /* stream_name must always be NULL if there is no stream. */
33 SMB_ASSERT(smb_fname->stream_name[0] != '\0');
35 *full_name = talloc_asprintf(ctx, "%s%s", smb_fname->base_name,
36 smb_fname->stream_name);
38 *full_name = talloc_strdup(ctx, smb_fname->base_name);
42 return NT_STATUS_NO_MEMORY;
49 * There are actually legitimate callers of this such as functions that
50 * enumerate streams using the vfs_streaminfo interface and then want to
51 * operate on each stream.
53 struct smb_filename *synthetic_smb_fname(TALLOC_CTX *mem_ctx,
54 const char *base_name,
55 const char *stream_name,
56 const SMB_STRUCT_STAT *psbuf)
58 struct smb_filename smb_fname_loc = { 0, };
60 /* Setup the base_name/stream_name. */
61 smb_fname_loc.base_name = discard_const_p(char, base_name);
62 smb_fname_loc.stream_name = discard_const_p(char, stream_name);
64 /* Copy the psbuf if one was given. */
66 smb_fname_loc.st = *psbuf;
68 /* Let cp_smb_filename() do the heavy lifting. */
69 return cp_smb_filename(mem_ctx, &smb_fname_loc);
73 * There are a few legitimate users of this.
75 struct smb_filename *synthetic_smb_fname_split(TALLOC_CTX *ctx,
79 char *stream_name = NULL;
80 char *base_name = NULL;
81 struct smb_filename *ret;
85 /* No stream name looked for. */
86 return synthetic_smb_fname(ctx, fname, NULL, NULL);
89 ok = split_stream_filename(ctx,
97 ret = synthetic_smb_fname(ctx, base_name, stream_name, NULL);
98 TALLOC_FREE(base_name);
99 TALLOC_FREE(stream_name);
104 * Return a string using the talloc_tos()
106 const char *smb_fname_str_dbg(const struct smb_filename *smb_fname)
111 if (smb_fname == NULL) {
114 status = get_full_smb_filename(talloc_tos(), smb_fname, &fname);
115 if (!NT_STATUS_IS_OK(status)) {
122 * Return a debug string of the path name of an fsp using the talloc_tos().
124 const char *fsp_str_dbg(const struct files_struct *fsp)
126 return smb_fname_str_dbg(fsp->fsp_name);
130 * Create a debug string for the fnum of an fsp.
132 * This is allocated to talloc_tos() or a string constant
133 * in certain corner cases. The returned string should
134 * hence not be free'd directly but only via the talloc stack.
136 const char *fsp_fnum_dbg(const struct files_struct *fsp)
141 return "fnum [fsp is NULL]";
144 if (fsp->fnum == FNUM_FIELD_INVALID) {
145 return "fnum [invalid value]";
148 str = talloc_asprintf(talloc_tos(), "fnum %llu",
149 (unsigned long long)fsp->fnum);
151 DEBUG(1, ("%s: talloc_asprintf failed\n", __FUNCTION__));
152 return "fnum [talloc failed!]";
158 struct smb_filename *cp_smb_filename(TALLOC_CTX *mem_ctx,
159 const struct smb_filename *in)
161 struct smb_filename *out;
163 size_t stream_len = 0;
164 size_t lcomp_len = 0;
167 /* stream_name must always be NULL if there is no stream. */
168 if (in->stream_name) {
169 SMB_ASSERT(in->stream_name[0] != '\0');
172 if (in->base_name != NULL) {
173 base_len = strlen(in->base_name) + 1;
176 if (in->stream_name != NULL) {
177 stream_len = strlen(in->stream_name) + 1;
180 if (in->original_lcomp != NULL) {
181 lcomp_len = strlen(in->original_lcomp) + 1;
185 out = talloc_pooled_object(mem_ctx, struct smb_filename,
186 num, stream_len + base_len + lcomp_len);
193 * The following allocations cannot fail as we
194 * pre-allocated space for them in the out pooled
197 if (in->base_name != NULL) {
198 out->base_name = talloc_memdup(
199 out, in->base_name, base_len);
200 talloc_set_name_const(out->base_name,
203 if (in->stream_name != NULL) {
204 out->stream_name = talloc_memdup(
205 out, in->stream_name, stream_len);
206 talloc_set_name_const(out->stream_name,
209 if (in->original_lcomp != NULL) {
210 out->original_lcomp = talloc_memdup(
211 out, in->original_lcomp, lcomp_len);
212 talloc_set_name_const(out->original_lcomp,
213 out->original_lcomp);
215 out->flags = in->flags;
220 /****************************************************************************
221 Simple check to determine if the filename is a stream.
222 ***************************************************************************/
223 bool is_ntfs_stream_smb_fname(const struct smb_filename *smb_fname)
225 /* stream_name must always be NULL if there is no stream. */
226 if (smb_fname->stream_name) {
227 SMB_ASSERT(smb_fname->stream_name[0] != '\0');
230 if (lp_posix_pathnames()) {
234 return smb_fname->stream_name != NULL;
237 /****************************************************************************
238 Returns true if the filename's stream == "::$DATA"
239 ***************************************************************************/
240 bool is_ntfs_default_stream_smb_fname(const struct smb_filename *smb_fname)
242 if (!is_ntfs_stream_smb_fname(smb_fname)) {
246 return strcasecmp_m(smb_fname->stream_name, "::$DATA") == 0;
249 /****************************************************************************
250 Filter out Windows invalid EA names (list probed from Windows 2012).
251 ****************************************************************************/
253 static char bad_ea_name_chars[] = "\"*+,/:;<=>?[\\]|";
255 bool is_invalid_windows_ea_name(const char *name)
258 /* EA name is pulled as ascii so we can examine
259 individual bytes here. */
260 for (i = 0; name[i] != 0; i++) {
261 int val = (name[i] & 0xff);
262 if (val < ' ' || strchr(bad_ea_name_chars, val)) {
269 bool ea_list_has_invalid_name(struct ea_list *ea_list)
271 for (;ea_list; ea_list = ea_list->next) {
272 if (is_invalid_windows_ea_name(ea_list->ea.name)) {
279 /****************************************************************************
280 Split an incoming name into tallocd filename and stream components.
281 Returns true on success, false on out of memory.
282 ****************************************************************************/
284 bool split_stream_filename(TALLOC_CTX *ctx,
285 const char *filename_in,
287 char **streamname_out)
289 const char *stream_name = NULL;
290 char *stream_out = NULL;
291 char *file_out = NULL;
293 stream_name = strchr_m(filename_in, ':');
296 stream_out = talloc_strdup(ctx, stream_name);
297 if (stream_out == NULL) {
300 file_out = talloc_strndup(ctx,
302 PTR_DIFF(stream_name, filename_in));
304 file_out = talloc_strdup(ctx, filename_in);
307 if (file_out == NULL) {
308 TALLOC_FREE(stream_out);
313 *filename_out = file_out;
315 if (streamname_out) {
316 *streamname_out = stream_out;