summaryrefslogtreecommitdiff
path: root/unittest/test_bsdmkstemp.cpp
blob: 881b06759a0a5e734d2863dfbc5976a64a35672a (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
209
210
211
212
213
214
215
216
217
218
219
220
221
// Copyright (C) 2020-2022 Joel Rosdahl and other contributors
//
// See doc/AUTHORS.adoc for a complete list of contributors.
//
// This program 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.
//
// This program 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, write to the Free Software Foundation, Inc., 51
// Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

#include "../src/Fd.hpp"
#include "../src/Finalizer.hpp"
#include "TestUtil.hpp"

#include <core/wincompat.hpp>

#include "third_party/doctest.h"
#include "third_party/win32/mktemp.h"

#include <sddl.h>

#include <algorithm>
#include <memory>
#include <ostream>
#include <utility>

using TestUtil::TestContext;

namespace {

class ScopedHANDLE
{
public:
  ScopedHANDLE() = default;

  explicit ScopedHANDLE(HANDLE handle) : m_handle(handle)
  {
  }

  ScopedHANDLE(ScopedHANDLE&& other) : ScopedHANDLE(other.release())
  {
  }

  ~ScopedHANDLE()
  {
    if (m_handle != INVALID_HANDLE_VALUE) {
      CloseHandle(m_handle);
    }
  }

  ScopedHANDLE&
  operator=(ScopedHANDLE rhs)
  {
    std::swap(m_handle, rhs.m_handle);
    return *this;
  }

  explicit operator bool() const
  {
    return m_handle != INVALID_HANDLE_VALUE;
  }

  HANDLE
  get() const
  {
    return m_handle;
  }

  HANDLE
  release()
  {
    HANDLE handle = m_handle;
    m_handle = INVALID_HANDLE_VALUE;
    return handle;
  }

private:
  HANDLE m_handle = INVALID_HANDLE_VALUE;
};

} // namespace

TEST_SUITE_BEGIN("bsd_mkstemps");

TEST_CASE("bsd_mkstemps")
{
  TestContext test_context;

  static uint16_t rand_iter;
  rand_iter = 0;

  bsd_mkstemp_set_random_source([](void* buf, size_t nbytes) {
    std::fill_n(
      static_cast<uint16_t*>(buf), nbytes / sizeof(uint16_t), rand_iter);
    ++rand_iter;
  });

  Finalizer reset_random_source([] { bsd_mkstemp_set_random_source(nullptr); });

  SUBCASE("successful")
  {
    std::string path = "XXXXXX";
    Fd fd(bsd_mkstemps(&path[0], 0));
    CHECK_MESSAGE(fd, "errno=" << errno);
    CHECK(path == "AAAAAA");
  }

  SUBCASE("successful with suffix")
  {
    std::string path = "XXXXXX123";
    Fd fd(bsd_mkstemps(&path[0], 3));
    CHECK_MESSAGE(fd, "errno=" << errno);
    CHECK(path == "AAAAAA123");
  }

  SUBCASE("existing file")
  {
    ScopedHANDLE handle(CreateFileA("AAAAAA",
                                    GENERIC_READ | GENERIC_WRITE,
                                    0,
                                    nullptr,
                                    CREATE_NEW,
                                    FILE_ATTRIBUTE_NORMAL,
                                    nullptr));
    CHECK_MESSAGE(handle, "errno=" << errno);

    std::string path = "XXXXXX";
    Fd fd(bsd_mkstemps(&path[0], 0));
    CHECK_MESSAGE(fd, "errno=" << errno);
    CHECK(path == "BBBBBB");
  }

  SUBCASE("existing file, pending delete")
  {
    ScopedHANDLE h;
    CHECK_MESSAGE(
      (h = ScopedHANDLE(CreateFileA("AAAAAA",
                                    GENERIC_READ | GENERIC_WRITE | DELETE,
                                    0,
                                    nullptr,
                                    CREATE_NEW,
                                    FILE_ATTRIBUTE_NORMAL,
                                    nullptr))),
      "errno=" << errno);

    // Mark file as deleted. This puts it into a "pending delete" state that
    // will persist until the handle is closed.
    FILE_DISPOSITION_INFO info{};
    info.DeleteFile = TRUE;
    CHECK_MESSAGE(SetFileInformationByHandle(
                    h.get(), FileDispositionInfo, &info, sizeof(info)),
                  "errno=" << errno);

    std::string path = "XXXXXX";
    Fd fd(bsd_mkstemps(&path[0], 0));
    CHECK_MESSAGE(fd, "errno=" << errno);
    CHECK(path == "BBBBBB");
  }

  SUBCASE("existing directory")
  {
    CHECK_MESSAGE(CreateDirectoryA("AAAAAA", nullptr), "errno=" << errno);

    std::string path = "XXXXXX";
    Fd fd(bsd_mkstemps(&path[0], 0));
    CHECK_MESSAGE(fd, "errno=" << errno);
    CHECK(path == "BBBBBB");
  }

  SUBCASE("permission denied")
  {
    auto make_ACL = [](const char* acl_string) {
      PSECURITY_DESCRIPTOR desc = nullptr;
      ConvertStringSecurityDescriptorToSecurityDescriptorA(
        acl_string, SDDL_REVISION_1, &desc, nullptr);
      return std::shared_ptr<SECURITY_DESCRIPTOR>(
        static_cast<SECURITY_DESCRIPTOR*>(desc), &LocalFree);
    };

    // Create a directory with a contrived ACL that denies creation of new files
    // and directories to the "Everybody" (WD) group.
    std::shared_ptr<SECURITY_DESCRIPTOR> desc;
    CHECK_MESSAGE((desc = make_ACL("D:(D;;DCLCRPCR;;;WD)(A;;FA;;;WD)")),
                  "errno=" << errno);

    SECURITY_ATTRIBUTES attrs{};
    attrs.nLength = sizeof(attrs);
    attrs.lpSecurityDescriptor = desc.get();
    CHECK_MESSAGE(CreateDirectoryA("my_readonly_dir", &attrs),
                  "errno=" << errno);

    // Sanity check that we cannot write to this directory. (E.g. Wine doesn't
    // appear to emulate Windows ACLs properly when run under root.)
    bool broken_acls = static_cast<bool>(ScopedHANDLE(
      CreateFileA("my_readonly_dir/.writable",
                  GENERIC_WRITE,
                  0,
                  nullptr,
                  CREATE_ALWAYS,
                  FILE_ATTRIBUTE_NORMAL | FILE_FLAG_DELETE_ON_CLOSE,
                  nullptr)));

    if (!broken_acls) {
      std::string path = "my_readonly_dir/XXXXXX";
      CHECK(!Fd(bsd_mkstemps(&path[0], 0)));
      CHECK(errno == EACCES);
    } else {
      MESSAGE("ACLs do not appear to function properly on this filesystem");
    }
  }
}

TEST_SUITE_END();