-
Notifications
You must be signed in to change notification settings - Fork 3k
/
cli-server.cpp
1769 lines (1487 loc) · 52 KB
/
cli-server.cpp
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
+----------------------------------------------------------------------+
| HipHop for PHP |
+----------------------------------------------------------------------+
| Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com) |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
*/
/*
Welcome to the CLI Server!
This file implements a unix socket based server for spawning "requests" which
behave (by-in-large) as though they were scripts executing in the context of
the client's UID. In order to achieve this the file implements the following
classes and abstractions:
================================ [ The Server ] ================================
== CLIServer
This class is a singleton representing an active CLIServer bound to a unix
socket. It carries with it a state: UNDEFINED, READY, RUNNING, or STOPPED.
- The server can be constructed via init_cli_server() which will call
CLIServer::CLIServer. This will bind() the unix socket and construct
the AsyncServerSocket.
- In order to begin accepting connections, start_cli_server() must be called,
it will spawn an event loop thread and begin accept()-ing connections. This
function will also construct a JobQueueDispatcher to handle connections.
- Once teardown_cli_server() is called the server will stop accepting new
connections and shutdown the dispatcher. This function will join the event
loop thread and then destruct the singleton instance of the CLIServer.
After constructing a CLIServer it is "READY" and once start() is called it will
either be "RUNNING" or if listen() or accept() fails "STOPPED".
A running CLIServer has an AsyncServerSocket bound to the unix socket on which
requests are served, as well as a std::thread executing the event loop for its
socket.
CLIServer offers separate init and start entry points in order to allow callers
to bind() the unix socket prior to dropping privileges, but defer new
connections until after privileges have been reset. This enables callers to
bind their sockets in privileged locations.
The teardown function must be called prior to process exit as JobQueue threads
may access global server state in their thread exit handlers.
== CLIWorker
These workers execute requests sent to the CLIServer and are managed by the
JobQueueDispatcher. The CLIWorker::doJob() function contains all of the server
side logic to extract the startup parameters from the client, manipulate the
ExecutionContext, and ultimately start the request via hphp_invoke.
Before beginning execution the doJob routine reads information from the client
over its unix socket. Most importantly it receives the client's stdin, stdout,
and stderr file-descriptors, a file-descriptor to communicate with the client's
light process pool, the command line arguments, and a JSON blob of INI settings.
The setup performed in doJob resembles normal command line execution. Notably,
however, the PHP_INI_USER options are read from the client as a JSON string and
used to override the server defaults, the STD[IN,OUT,ERR] constants are defined
the ExecutionContext is instructed to write to the client's stdout, and the
LightProcess abstraction is given an override socket to allow the client to
spawn child processes via its own light process pool (so that commands executed
by proc_open and friends have the correct uid/gid). Additionally the cwd is set
to the client's cwd, the is_cli_mode() function returns true, and safe
directory access is disabled.
Lastly, a special file wrapper, CLIWrapper, is set to handle all local file
system operations.
== Monitor thread
The CLIWorker will spawn a special monitor thread just prior to starting
the request. This thread will poll() the unix socket and wait for flags that
indicate the client has hung-up, the socket is in an error state, or the
file-descriptor is no longer valid. At this point it will set the TimedOutFlag
on the request and terminate. This ensure that if the client hangs up (by ^C
for instance), the server does not continue spinning, and promptly releases the
clients I/O file descriptors (which may remain open if the underlying terminal
is still active).
== CLIWrapper
This special Stream::Wrapper implements all file:// IO for requests handled by
CLIServer. It proxies all syscalls to the client process over the unix socket
connection. The client responds with the results of these calls, and in the
case of open() and opendir(), with the actual file-descriptors it opened (via
SCM_RIGHTS).
================================ [ The Client ] ================================
== cli_process_command_loop
After establishing a connection and transferring INI-settings and file-
descriptors to the server, the client sits in the cli_process_command_loop. In
this loop the client handles requests from the CLIWrapper, commands are sent
as strings followed by arguments. The special "exit" command is sent when
the request completes along with an argument indicating the code with which
the client should terminate.
== run_command_on_cli_server
This is the main entry point for the client. It attempts to establish a
connection with the CLIServer and transfers the initialization information and
file descriptors required by the server. The file descriptor for a specially
constructed light process pool is also sent to the server. If the client is
unable to establish a connection the function will return allowing the caller
to execute locally or fail. If an error occurs after the connection is
established or the server completes the request the function will not return.
Should an error occur executing locally is unsafe as the client will have no
way to determine how much progress the server made.
*/
#include "hphp/runtime/server/cli-server.h"
#include "hphp/runtime/base/array-iterator.h"
#include "hphp/runtime/base/execution-context.h"
#include "hphp/runtime/base/file-util.h"
#include "hphp/runtime/base/ini-setting.h"
#include "hphp/runtime/base/plain-file.h"
#include "hphp/runtime/base/program-functions.h"
#include "hphp/runtime/base/runtime-option.h"
#include "hphp/runtime/base/surprise-flags.h"
#include "hphp/runtime/base/stream-wrapper-registry.h"
#include "hphp/runtime/base/stream-wrapper.h"
#include "hphp/runtime/base/string-util.h"
#include "hphp/runtime/base/thread-info.h"
#include "hphp/runtime/base/type-array.h"
#include "hphp/runtime/base/type-string.h"
#include "hphp/runtime/base/type-variant.h"
#include "hphp/runtime/base/unit-cache.h"
#include "hphp/runtime/ext/json/ext_json.h"
#include "hphp/runtime/server/job-queue-vm-stack.h"
#include "hphp/util/afdt-util.h"
#include "hphp/util/job-queue.h"
#include "hphp/util/light-process.h"
#include "hphp/util/logger.h"
#include "hphp/util/process.h"
#include "hphp/util/trace.h"
#include <folly/io/async/AsyncServerSocket.h>
#include <folly/io/async/EventBaseManager.h>
#include <folly/portability/Sockets.h>
#include <afdt.h>
#include <errno.h>
#include <grp.h>
#include <pwd.h>
#include <utime.h>
TRACE_SET_MOD(clisrv);
namespace HPHP {
/*
* READ BEFORE MODIFYING THE CLI SERVER PROTOCOL
* ===== WARNING ===== WARNING ===== WARNING ===== WARNING ===== WARNING =====
*
* The CLI client and server use CLI_SERVER_API_VERSION to negotiate a
* conncection, any changes to their API must include a bump of this version.
* Version is not tied to HHVM compiler-id because changes rarely affect
* communication between the server and client.
*
* ===== WARNING ===== WARNING ===== WARNING ===== WARNING ===== WARNING =====
*/
const uint64_t CLI_SERVER_API_VERSION = 1;
const StaticString s_hphp_cli_server_api_version("hphp.cli_server_api_version");
struct CLIClientGuardedFile : PlainFile {
explicit CLIClientGuardedFile(int fd) :
PlainFile(fd)
{ }
int64_t readImpl(char *buffer, int64_t length) override {
assertClientAlive();
return PlainFile::readImpl(buffer, length);
}
int getc() override {
assertClientAlive();
return PlainFile::getc();
}
String read() override {
assertClientAlive();
return PlainFile::read();
}
String read(int64_t length) override {
assertClientAlive();
return PlainFile::read(length);
}
int64_t writeImpl(const char *buffer, int64_t length) override {
assertClientAlive();
return PlainFile::writeImpl(buffer, length);
}
bool seek(int64_t offset, int whence = SEEK_SET) override {
assertClientAlive();
return PlainFile::seek(offset, whence);
}
int64_t tell() override {
assertClientAlive();
return PlainFile::tell();
}
bool eof() override {
assertClientAlive();
return PlainFile::eof();
}
bool rewind() override {
assertClientAlive();
return PlainFile::rewind();
}
bool flush() override {
assertClientAlive();
return PlainFile::flush();
}
bool truncate(int64_t size) override {
assertClientAlive();
return PlainFile::truncate(size);
}
private:
void assertClientAlive() {
if (stackLimitAndSurprise().load() & CLIClientTerminated) {
raise_fatal_error("File I/O blocked as CLI client terminated");
}
}
};
static_assert(sizeof(CLIClientGuardedFile) == sizeof(PlainFile),
"CLIClientGuardedFile inherits PlainFile::heapSize()");
namespace {
template<class... Args>
void cli_write(int afdt_fd, Args&&... args) {
FTRACE(4, "cli_write({}, nargs={})\n", afdt_fd, sizeof...(args) + 1);
try {
afdt::sendx(afdt_fd, std::forward<Args>(args)...);
} catch (const std::runtime_error& ex) {
throw Exception("Failed in afdt::sendRaw: %s [%s]",
ex.what(), folly::errnoStr(errno).c_str());
}
}
template<class... Args>
void cli_read(int afdt_fd, Args&&... args) {
FTRACE(4, "cli_read({}, nargs={})\n", afdt_fd, sizeof...(args) + 1);
try {
afdt::recvx(afdt_fd, std::forward<Args>(args)...);
} catch (const std::runtime_error& ex) {
throw Exception("Failed in afdt::recvRaw: %s [%s]",
ex.what(), folly::errnoStr(errno).c_str());
}
}
int cli_read_fd(int afdt_fd) {
int fd = afdt::recv_fd(afdt_fd);
FTRACE(4, "{} = cli_read_fd({})\n", fd, afdt_fd);
if (fd < 0) {
throw Exception("Failed in afdt::recv_fd: %s",
folly::errnoStr(errno).c_str());
}
return fd;
}
void cli_write_fd(int afdt_fd, int fd) {
FTRACE(4, "cli_write_fd({}, {})\n", afdt_fd, fd);
if (!afdt::send_fd(afdt_fd, fd)) {
throw Exception("Failed in afdt::send_fd: %s",
folly::errnoStr(errno).c_str());
}
}
#ifdef SCM_CREDENTIALS
template<class F, class R = typename std::result_of<F(msghdr*)>::type>
R with_ucred_message(int fd, F func) {
iovec iov;
int data = 1;
msghdr msgh;
union {
struct cmsghdr cmh;
char space[CMSG_SPACE(sizeof(ucred))];
} control_un;
bzero(&control_un, sizeof(control_un));
bzero(&msgh, sizeof(msgh));
control_un.cmh.cmsg_len = CMSG_LEN(sizeof(ucred));
control_un.cmh.cmsg_level = SOL_SOCKET;
control_un.cmh.cmsg_type = SCM_CREDENTIALS;
iov.iov_base = &data;
iov.iov_len = sizeof(data);
msgh.msg_iov = &iov;
msgh.msg_iovlen = 1;
msgh.msg_control = &control_un.cmh;
msgh.msg_controllen = sizeof(control_un);
auto set_passcred = [&] (int val) {
if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &val, sizeof(val)) == -1) {
throw Exception("Could not set socket to SO_PASSCRED: %s",
folly::errnoStr(errno).c_str());
}
};
set_passcred(1);
SCOPE_EXIT { set_passcred(0); };
return func(&msgh);
}
ucred cli_read_ucred(int fd) {
return with_ucred_message(fd, [&] (msghdr* msgh) -> ucred {
ssize_t ret = recvmsg(fd, msgh, MSG_WAITALL);
if (ret < 0) {
FTRACE(4, "cli_read_ucred({}): %s\n", fd, folly::errnoStr(errno));
throw Exception("cli_read_ucred: recvmsg failed: %s",
folly::errnoStr(errno).c_str());
}
auto cmhp = CMSG_FIRSTHDR(msgh);
if (!cmhp ||
cmhp->cmsg_len != CMSG_LEN(sizeof(ucred)) ||
cmhp->cmsg_level != SOL_SOCKET ||
cmhp->cmsg_type != SCM_CREDENTIALS) {
FTRACE(4, "cli_read_ucred({}): bad payload\n");
throw Exception("cli_read_ucred: malformed response");
}
auto uc = (ucred*)CMSG_DATA(cmhp);
FTRACE(4, "cli_read_ucred({}): ret = {} UID = {}, GID = {}, PID = {}\n",
fd, ret, uc->uid, uc->gid, uc->pid);
return ucred {uc->pid, uc->uid, uc->gid};
});
}
void cli_write_ucred(int fd) {
return with_ucred_message(fd, [&] (msghdr* msgh) {
auto cred = (ucred*)CMSG_DATA(CMSG_FIRSTHDR(msgh));
cred->uid = getuid();
cred->gid = getgid();
cred->pid = getpid();
ssize_t ret = sendmsg(fd, msgh, MSG_WAITALL);
FTRACE(4, "cli_write_ucred({}): ret = {} UID = {}, GID = {}, PID = {}\n",
fd, ret, cred->uid, cred->gid, cred->pid);
if (ret < 0) {
FTRACE(4, "cli_write_ucred({}): %s\n", fd, folly::errnoStr(errno));
throw Exception("cli_write_ucred: sendmsg failed: %s",
folly::errnoStr(errno).c_str());
}
});
}
#else /* defined(SCM_CREDENTIALS) */
ucred cli_read_ucred(int fd) {
ucred u;
if (getpeereid(fd, &u.uid, &u.gid) == -1) {
throw Exception("getpeerid: %s", folly::errnoStr(errno).c_str());
}
u.pid = getpid();
return u;
}
void cli_write_ucred(int fd) {}
#endif /* defined(SCM_CREDENTIALS) */
////////////////////////////////////////////////////////////////////////////////
struct CLIWorker
: JobQueueWorker<int,void*,true,false,JobQueueDropVMStack>
{
void doJob(int fd) override;
void abortJob(int fd) override {
Logger::Warning("CLI request (%i) dropped because of timeout.", fd);
close(fd);
}
};
struct CLIWrapper final : Stream::ExtendedWrapper {
explicit CLIWrapper(int fd) : m_cli_fd(fd) {}
req::ptr<File> open(const String& filename,
const String& mode,
int options,
const req::ptr<StreamContext>& context) override;
int access(const String& path, int mode) override;
int lstat(const String& path, struct stat* buf) override;
int stat(const String& path, struct stat* buf) override;
int unlink(const String& path) override;
int rename(const String& oldname, const String& newname) override;
int mkdir(const String& path, int mode, int options) override;
int rmdir(const String& path, int options) override;
req::ptr<Directory> opendir(const String& path) override;
String realpath(const String& path) override;
// extended api
bool touch(const String& path, int64_t mtime, int64_t atime) override;
bool chmod(const String& path, int64_t mode) override;
bool chown(const String& path, int64_t uid) override;
bool chown(const String& path, const String& uid) override;
bool chgrp(const String& path, int64_t gid) override;
bool chgrp(const String& path, const String& gid) override;
bool isNormalFileStream() const override { return true; }
private:
int m_cli_fd;
};
struct CLIServer final : folly::AsyncServerSocket::AcceptCallback {
explicit CLIServer(const char* path);
~CLIServer() = default;
void start();
void stop();
void connectionAccepted(int fd,
const folly::SocketAddress&) noexcept override {
if (RuntimeOption::EvalUnixServerFailWhenBusy) {
if (m_dispatcher->getActiveWorker() >=
m_dispatcher->getTargetNumWorkers()) {
Logger::Info("Queue is full, refusing CLI connection");
close(fd);
return;
}
}
Logger::Info("Accepting CLI connection");
FTRACE(1, "CLIServer::connectionAccepted({}): enqueue job\n", fd);
int opts = fcntl(fd, F_GETFL);
int res = fcntl(fd, F_SETFL, opts & ~O_NONBLOCK);
if (res) {
Logger::Warning("Could not set socket to blocking: %s",
folly::errnoStr(errno).c_str());
close(fd);
return;
}
m_dispatcher->enqueue(fd);
}
void acceptError(const std::exception& ex) noexcept override {
Logger::Warning("Error accepting connection: %s", ex.what());
}
private:
enum class State { UNINIT, READY, RUNNING, STOPPED };
using JobQueue = JobQueueDispatcher<CLIWorker>;
std::unique_lock<std::mutex> lockState() {
return std::unique_lock<std::mutex>(m_stateLock);
}
void waitFor(State s) {
auto lock = lockState();
m_stateCV.wait(lock, [=] {
return m_state.load(std::memory_order_relaxed) == s;
});
}
void waitWhile(State s) {
auto lock = lockState();
m_stateCV.wait(lock, [=] {
return m_state.load(std::memory_order_relaxed) != s;
});
}
void setState(State s) {
auto lock = lockState();
m_state.store(s, std::memory_order_relaxed);
lock.unlock();
m_stateCV.notify_all();
}
State getState() const { return m_state.load(std::memory_order_relaxed); }
folly::EventBase* m_ev{nullptr};
std::atomic<State> m_state{State::UNINIT};
std::mutex m_stateLock;
std::condition_variable m_stateCV;
std::thread m_mainThread;
folly::AsyncServerSocket::UniquePtr m_server;
std::unique_ptr<JobQueue> m_dispatcher;
};
CLIServer* s_cliServer{nullptr};
__thread ucred* tl_ucred{nullptr};
__thread int tl_cliSock{-1};
__thread Array* tl_env;
////////////////////////////////////////////////////////////////////////////////
CLIServer::CLIServer(const char* path) {
int err = unlink(path);
if (err != 0 && errno != ENOENT) {
Logger::Warning("Could not delete defunct unix socket: %s (%s)",
path, folly::errnoStr(errno).c_str());
setState(State::STOPPED);
return;
}
folly::SocketAddress addr;
addr.setFromPath(path);
m_server.reset(new folly::AsyncServerSocket());
try {
m_server->bind(addr);
} catch (const std::exception& ex) {
Logger::Warning("Unable to bind unix socket: %s", ex.what());
m_server.reset();
setState(State::STOPPED);
return;
}
if (chmod(path, 0666) == -1) {
Logger::Warning("Unable to chmod unix socket: %s",
folly::errnoStr(errno).c_str());
}
setState(State::READY);
}
void CLIServer::start() {
if (getState() != State::READY) return;
m_dispatcher = std::make_unique<JobQueue>(
RuntimeOption::EvalUnixServerWorkers,
RuntimeOption::ServerThreadDropCacheTimeoutSeconds,
RuntimeOption::ServerThreadDropStack,
nullptr
);
m_dispatcher->start();
m_mainThread = std::thread([&] {
m_ev = folly::EventBaseManager::get()->getEventBase();
Logger::Info("CLI server thread starting");
FTRACE(1, "CLIServer::start(): starting...\n");
try {
m_server->listen(RuntimeOption::ServerBacklog);
m_server->startAccepting();
} catch (const std::exception& ex) {
Logger::Warning("Unable to begin accepting CLI connections: %s",
ex.what());
m_dispatcher->stop();
m_server.reset();
m_dispatcher.reset();
setState(State::STOPPED);
return;
}
m_server->attachEventBase(m_ev);
m_server->addAcceptCallback(this, nullptr);
setState(State::RUNNING);
m_ev->loop();
Logger::Info("CLI server thread terminating");
});
waitWhile(State::READY);
}
void CLIServer::stop() {
if (getState() != State::RUNNING) return;
m_ev->runInEventBaseThread([&] {
FTRACE(1, "CLIServer::stop(): stopping...\n");
m_server.reset();
setState(State::STOPPED);
});
m_dispatcher->stop();
m_dispatcher.reset();
waitFor(State::STOPPED);
m_mainThread.join();
}
////////////////////////////////////////////////////////////////////////////////
namespace {
struct CliStdoutHook final : ExecutionContext::StdoutHook {
int fd;
explicit CliStdoutHook(int fd) : fd(fd) {}
void operator()(const char* s, int len) override {
if (!(stackLimitAndSurprise().load() & CLIClientTerminated)) {
write(fd, s, len);
}
}
};
struct CliLoggerHook final : LoggerHook {
int fd;
explicit CliLoggerHook(int fd) : fd(fd) {}
void operator()(const char* /*hdr*/, const char* msg, const char* ending)
override {
if (!(stackLimitAndSurprise().load() & CLIClientTerminated)) {
write(fd, msg, strlen(msg));
if (ending) write(fd, ending, strlen(ending));
}
}
};
}
const StaticString
s_STDIN("STDIN"),
s_STDOUT("STDOUT"),
s_STDERR("STDERR");
void define_stdio_constants() {
auto defcns = [] (const StringData* name, const Variant& (*func)()) {
auto handle = makeCnsHandle(name);
always_assert(rds::isHandleBound(handle));
rds::initHandle(handle);
auto cns = &rds::handleToRef<TypedValue>(handle);
cns->m_type = KindOfUninit;
cns->m_data.pref = reinterpret_cast<RefData*>(func);
};
defcns(s_STDIN.get(), BuiltinFiles::GetSTDIN);
defcns(s_STDOUT.get(), BuiltinFiles::GetSTDOUT);
defcns(s_STDERR.get(), BuiltinFiles::GetSTDERR);
}
const StaticString
s_local_value("local_value"),
s_access("access");
Array init_ini_settings(const std::string& settings) {
String s(settings.c_str(), CopyString);
auto var = Variant::attach(HHVM_FN(json_decode)(s, true));
FTRACE(1, "init_ini_settings: CLI server decoding settings\n");
if (!var.isArray()) {
Logger::Warning("CLI server received malformed INI settings: %.64s%s",
settings.c_str(), settings.size() > 64 ? "..." : "");
return Array{};
}
FTRACE(1, "init_ini_settings: {} settings to process\n",
var.toArray().size());
UNUSED int count = 0;
for (ArrayIter it(var.toArray()); it; ++it) {
if (!it.first().isString()) {
Logger::Warning("CLI server received a malformed INI setting name");
continue;
}
if (!it.second().isString() && !it.second().isArray()) {
Logger::Warning("CLI server received a malformed INI setting value");
continue;
}
auto name = it.first().toString();
auto detail = it.second().toArray();
auto value = detail[s_local_value];
if ((detail[s_access].toInt64() & IniSetting::PHP_INI_USER) == 0) {
FTRACE(5, "init_ini_settings: skipping INI setting {} = {}\n",
name.data(),
value.isArray() || value.isObject()
? "[array]"
: value.toString().c_str());
continue;
}
FTRACE(5, "init_ini_settings: loading INI setting {} = {}\n",
name.data(),
value.isArray() ? "[array]" : value.toString().c_str());
bool res = IniSetting::SetUser(name, value);
if (!res) {
FTRACE(5, "init_ini_settings: unable to set PHP_INI_USER setting: {} "
"(access = {})\n", name, detail[s_access].toInt64());
Logger::Warning("CLI server received an invalid INI setting: %s "
"(access = %li)",
name.data(), detail[s_access].toInt64());
} else {
count++;
}
}
FTRACE(1, "init_ini_settings: loaded {} settings\n", count);
return var.toArray();
}
std::unordered_set<uid_t> s_allowedUsers;
std::unordered_set<gid_t> s_allowedGroups;
struct UserInfo final {
explicit UserInfo(const char* name) {
passwd* retpwptr = nullptr;
int pwbuflen = sysconf(_SC_GETPW_R_SIZE_MAX);
if (pwbuflen < 1) {
throw Exception("Could not get _SC_GETPW_R_SIZE_MAX");
}
pwbuf.reset(new char[pwbuflen]);
if (getpwnam_r(name, &pwd, pwbuf.get(), pwbuflen, &retpwptr)) {
throw Exception("getpwnam_r: %s", folly::errnoStr(errno).c_str());
}
if (!retpwptr) {
throw Exception("getpwnam_r: no such user: %s", name);
}
}
explicit UserInfo(uid_t uid) {
passwd* retpwptr = nullptr;
int pwbuflen = sysconf(_SC_GETPW_R_SIZE_MAX);
if (pwbuflen < 1) {
throw Exception("Could not get _SC_GETPW_R_SIZE_MAX");
}
pwbuf.reset(new char[pwbuflen]);
if (getpwuid_r(uid, &pwd, pwbuf.get(), pwbuflen, &retpwptr)) {
throw Exception("getpwuid_r: %s", folly::errnoStr(errno).c_str());
}
if (!retpwptr) {
throw Exception("getpwuid_r: no such uid: %u", uid);
}
}
passwd pwd;
std::unique_ptr<char[]> pwbuf;
};
struct GroupInfo final {
explicit GroupInfo(const char* name) {
group* retgrptr = nullptr;
int grbuflen = sysconf(_SC_GETGR_R_SIZE_MAX);
if (grbuflen < 1) {
throw Exception("Could not get _SC_GETGR_R_SIZE_MAX");
}
grbuf.reset(new char[grbuflen]);
if (getgrnam_r(name, &gr, grbuf.get(), grbuflen, &retgrptr)) {
throw Exception("getgrnam_r: %s", folly::errnoStr(errno).c_str());
}
if (!retgrptr) {
throw Exception("getgrnam_r: no such group: %s", name);
}
}
group gr;
std::unique_ptr<char[]> grbuf;
};
void check_cli_server_access(ucred& cred) {
// Fail closed
if (s_allowedUsers.empty() && s_allowedGroups.empty()) {
if (cred.uid == getuid()) return;
throw Exception("access denied");
}
FTRACE(2, "Checking access for uid = {}\n", cred.uid);
// Fast checks
if (s_allowedUsers.find(cred.uid) != s_allowedUsers.end()) return;
if (s_allowedGroups.find(cred.gid) != s_allowedGroups.end()) return;
try {
if (!s_allowedGroups.empty()) {
FTRACE(2, "check_cli_server_access: starting slow check...\n");
// The signature for getgrouplist differs for Apple
#ifdef __APPLE__
std::vector<int> groups;
#else
std::vector<gid_t> groups;
#endif
int ngroups = 0;
UserInfo user(cred.uid);
if (getgrouplist(user.pwd.pw_name, cred.gid, nullptr, &ngroups) != -1) {
FTRACE(2, "check_cli_server_access: oops 1...\n");
throw Exception("getgrouplist: could not get ngroups");
}
FTRACE(2, "Will check {} groups for user {}\n",
ngroups, user.pwd.pw_name);
groups.resize(ngroups);
if (getgrouplist(user.pwd.pw_name, cred.gid, &groups[0], &ngroups) < 0) {
FTRACE(2, "check_cli_server_access: oops 2...\n");
throw Exception("getgrouplist: invalid return value");
}
for (int i = 0; i < ngroups; ++i) {
FTRACE(2, "Checking access for gid = {}\n", groups[i]);
if (s_allowedGroups.find((gid_t)groups[i]) != s_allowedGroups.end()) {
return;
}
}
}
} catch (const Exception& ex) {
Logger::Warning("Error checking access to CLI server: %s", ex.what());
}
throw Exception("access denied");
}
const StaticString
s_serverVariablesIni("hhvm.server_variables"),
s_envVariablesIni("hhvm.env_variables");
Array init_cli_globals(int argc, char** argv, int xhprof, Array& ini,
char** envp) {
auto make_map = [] (const Variant& v) {
std::map<std::string,std::string> ret;
if (!v.isArray()) return ret;
auto ar = v.toArray();
for (ArrayIter iter(ar); iter; ++iter) {
if (iter.first().isString() && iter.second().isString()) {
ret.emplace(
std::string(iter.first().toString().data()),
std::string(iter.second().toString().data())
);
}
}
return ret;
};
Array retEnv;
std::map<std::string,std::string> envVariables;
std::map<std::string,std::string> serverVariables;
if (ini.exists(s_serverVariablesIni)) {
serverVariables = make_map(ini[s_serverVariablesIni]);
}
if (ini.exists(s_envVariablesIni)) {
envVariables = make_map(ini[s_envVariablesIni]);
for (const auto& envvar : envVariables) {
retEnv.set(String(envvar.first), String(envvar.second));
}
} else {
retEnv = empty_array();
}
for (auto env = envp; *env; ++env) {
char *p = strchr(*env, '=');
if (p) {
String name(*env, p - *env, CopyString);
String val(p + 1, CopyString);
retEnv.set(name, val);
}
}
init_command_line_globals(argc, argv, envp, xhprof, envVariables,
serverVariables);
return retEnv;
}
struct RemoteFile final {
explicit RemoteFile(int client, const char* name, const char* mode) {
fd = cli_read_fd(client);
file = fdopen(fd, mode);
FTRACE(2, "CLIWorker::doJob({}): {} = {}\n", client, name, fd);
}
~RemoteFile() { if (file) fclose(file); }
FILE* file{nullptr};
int fd{-1};
};
struct MonitorThread final {
explicit MonitorThread(int client);
~MonitorThread() {
if (m_monitor.joinable()) {
write(m_wpipe, "stop", 5);
m_monitor.join();
}
}
private:
int m_wpipe{-1};
std::thread m_monitor;
};
MonitorThread::MonitorThread(int client) {
int monitor_pipe[2];
if (pipe(monitor_pipe) == -1) {
throw Exception("Unable to construct pipe for monitor: %s",
folly::errnoStr(errno).c_str());
}
int rpipe = monitor_pipe[0];
int wpipe = monitor_pipe[1];
auto flags = &stackLimitAndSurprise();
try {
m_monitor = std::thread([wpipe,rpipe,client,flags] {
SCOPE_EXIT {
close(rpipe);
close(wpipe);
};
int ret = 0;
pollfd pfd[] = {{client, 0, 0}, {rpipe, POLLIN, 0}};
while ((ret = poll(pfd, 2, -1)) != -1) {
if (ret == 0) continue;
if (pfd[0].revents & (POLLHUP | POLLERR | POLLNVAL)) {
FTRACE(2, "CLIWorker::doJob({}): observed socket reset in monitor\n",
client);
Logger::Info("CLIWorker::doJob(%i): monitor thread aborting request",
client);
flags->fetch_or(CLIClientTerminated);
return;
}
if (pfd[1].revents) {
FTRACE(2, "CLIWorker::doJob({}): monitor got request completed\n",
client);
return;
}
}
Logger::Warning("CLIWorker::doJob(%i): monitor thread terminated: %s",
client, folly::errnoStr(errno).c_str());
FTRACE(2, "CLIWorker::doJob({}): got error in monitor thread: {}",
client, folly::errnoStr(errno));
});
} catch (const std::system_error& err) {
close(rpipe);
close(wpipe);
throw Exception("Could not start monitor thread: %s", err.what());
}
m_wpipe = wpipe;
}
const StaticString s_hhvm_prelude_path("hhvm.prelude_path");
void CLIWorker::doJob(int client) {
FTRACE(1, "CLIWorker::doJob({}): starting job...\n", client);
try {
auto uc = cli_read_ucred(client);
// Throw if the client is not authorized to access the CLI server
check_cli_server_access(uc);
std::string magic;
cli_read(client, magic);
FTRACE(2, "CLIWorker::doJob({}): magic = {}\n", client, magic);
if (magic != "hello_server") {
throw Exception("Got bad magic from client: %s", magic.c_str());
}
std::string cwd;
cli_read(client, cwd);
FTRACE(1, "CLIWorker::doJob({}): cwd = {}\n", client, cwd);
std::string iniSettings;
cli_read(client, iniSettings);
RemoteFile cli_in(client, "stdin", "r");
RemoteFile cli_out(client, "stdout", "w");
RemoteFile cli_err(client, "stderr", "w");
RemoteFile cli_afdt(client, "afdt", "rw");
int xhprofFlags;
std::vector<std::string> args;
std::vector<std::string> env;
cli_read(client, xhprofFlags, args, env);
FTRACE(2, "CLIWorker::doJob({}): xhprofFlags = {}\n", client, xhprofFlags);
FTRACE(2, "CLIWorker::doJob({}): args = \n", client);
auto buf = std::make_unique<char*[]>(args.size());
for (int i = 0; i < args.size(); ++i) {
FTRACE(2, "CLIWorker::doJob({}): {}\n", client, args[i]);
buf[i] = const_cast<char*>(args[i].c_str());
}
FTRACE(3, "CLIWorker::doJob({}): env = \n", client);