aboutsummaryrefslogtreecommitdiffstats
path: root/kbx/keybox-util.c
blob: 740ea73b482334f17a7ba552d97692c922ef002c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/* keybox-util.c - Utility functions for Keybox
 *	Copyright (C) 2001 Free Software Foundation, Inc.
 *
 * This file is part of GnuPG.
 *
 * GnuPG is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * GnuPG is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#ifdef  HAVE_DOSISH_SYSTEM
# define WIN32_LEAN_AND_MEAN  /* We only need the OS core stuff.  */
# include <windows.h>
#endif

#include "keybox-defs.h"


static void *(*alloc_func)(size_t n) = malloc;
static void *(*realloc_func)(void *p, size_t n) = realloc;
static void (*free_func)(void*) = free;



void
keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
                          void *(*new_realloc_func)(void *p, size_t n),
                          void (*new_free_func)(void*) )
{
  alloc_func	    = new_alloc_func;
  realloc_func      = new_realloc_func;
  free_func	    = new_free_func;
}

void *
_keybox_malloc (size_t n)
{
  return alloc_func (n);
}

void *
_keybox_realloc (void *a, size_t n)
{
  return realloc_func (a, n);
}

void *
_keybox_calloc (size_t n, size_t m)
{
  void *p = _keybox_malloc (n*m);
  if (p)
    memset (p, 0, n* m);
  return p;
}

void
_keybox_free (void *p)
{
  if (p)
    free_func (p);
}


/* Store the two malloced temporary file names used for keybox updates
   of file FILENAME at R_BAKNAME and R_TMPNAME.  On error an error
   code is returned and NULL stored at R_BAKNAME and R_TMPNAME.  If
   FOR_KEYRING is true the returned names match those used by GnuPG's
   keyring code.  */
gpg_error_t
keybox_tmp_names (const char *filename, int for_keyring,
                  char **r_bakname, char **r_tmpname)
{
  gpg_error_t err;
  char *bak_name, *tmp_name;

  *r_bakname = NULL;
  *r_tmpname = NULL;

# ifdef USE_ONLY_8DOT3
  /* Here is another Windoze bug?:
   * you can't rename("pubring.kbx.tmp", "pubring.kbx");
   * but	rename("pubring.kbx.tmp", "pubring.aaa");
   * works.  So we replace ".kbx" by ".kb_" or ".k__".  Note that we
   * can't use ".bak" and ".tmp", because these suffixes are used by
   * gpg's keyrings and would lead to a sharing violation or data
   * corruption.  If the name does not end in ".kbx" we assume working
   * on a modern file system and append the suffix.  */
  {
    const char *ext   = for_keyring? EXTSEP_S GPGEXT_GPG : EXTSEP_S "kbx";
    const char *b_ext = for_keyring? EXTSEP_S "bak"      : EXTSEP_S "kb_";
    const char *t_ext = for_keyring? EXTSEP_S "tmp"      : EXTSEP_S "k__";
    int repl;

    if (strlen (ext) != 4 || strlen (b_ext) != 4)
      BUG ();
    repl = (strlen (filename) > 4
            && !strcmp (filename + strlen (filename) - 4, ext));
    bak_name = xtrymalloc (strlen (filename) + (repl?0:4) + 1);
    if (!bak_name)
      return gpg_error_from_syserror ();
    strcpy (bak_name, filename);
    strcpy (bak_name + strlen (filename) - (repl?4:0), b_ext);

    tmp_name = xtrymalloc (strlen (filename) + (repl?0:4) + 1);
    if (!tmp_name)
      {
        err = gpg_error_from_syserror ();
        xfree (bak_name);
        return err;
      }
    strcpy (tmp_name, filename);
    strcpy (tmp_name + strlen (filename) - (repl?4:0), t_ext);
  }
# else /* Posix file names */
  (void)for_keyring;
  bak_name = xtrymalloc (strlen (filename) + 2);
  if (!bak_name)
    return gpg_error_from_syserror ();
  strcpy (stpcpy (bak_name, filename), "~");

  tmp_name = xtrymalloc (strlen (filename) + 5);
  if (!tmp_name)
    {
      err = gpg_error_from_syserror ();
      xfree (bak_name);
      return err;
    }
  strcpy (stpcpy (tmp_name,filename), EXTSEP_S "tmp");
# endif /* Posix filename */

  *r_bakname = bak_name;
  *r_tmpname = tmp_name;
  return 0;
}


/* Wrapper for rename(2) to handle Windows peculiarities.  */
gpg_error_t
keybox_file_rename (const char *oldname, const char *newname)
{
  gpg_error_t err = 0;

#ifdef HAVE_DOSISH_SYSTEM
  int wtime = 0;

  gnupg_remove (newname);
 again:
  if (rename (oldname, newname))
    {
      if (GetLastError () == ERROR_SHARING_VIOLATION)
        {
          /* Another process has the file open.  We do not use a lock
           * for read but instead we wait until the other process has
           * closed the file.  This may take long but that would also
           * be the case with a dotlock approach for read and write.
           * Note that we don't need this on Unix due to the inode
           * concept.
           *
           * So let's wait until the rename has worked.  We use the
           * same retry intervals as used by dotlock.c, namely 50ms,
           * 100ms, 200ms, 400ms, 800ms, 2s, 4s and 8s.  */
          if (!wtime)
            wtime = 50;
          else if (wtime < 800)
            wtime *= 2;
          else if (wtime == 800)
            wtime = 2000;
          else if (wtime < 8000)
            wtime *= 2;

          if (wtime >= 800)
            log_info ("waiting for file '%s' to become accessible ...\n",
                      oldname);

          Sleep (wtime);
          goto again;
        }
      err = gpg_error_from_syserror ();
    }

#else /* Unix */

#ifdef __riscos__
  gnupg_remove (newname);
#endif
  if (rename (oldname, newname) )
    err = gpg_error_from_syserror ();

#endif /* Unix */

  if (err)
    log_error ("renaming '%s' to '%s' failed: %s\n",
               oldname, newname, gpg_strerror (err));
  return err;
}