[Samba] RFC: Windows Search Protocol Update
npower
npower at samba.org
Tue Apr 29 15:45:45 UTC 2025
Hi all,
If you are interested in enabling (or testing out) the work in progress
Windows Search Protocol search for samba then please have a look below
On a side note if you currently use the spotlight support there is a
relevant merge/review request to allow either an elasticsearch user or
apikey be configured for authentication. If anyone who uses spotlight
support has some thoughts on the enhancement I'd be happy to hear your
views. (please see below and/or
https://gitlab.com/samba-team/samba/-/merge_requests/3720 for more
information)
Anyway I sent the following message to samba-technical a while back but
should have probably sent it to here to 'samba at lists' also
[...]
Every now and again I get people contacting me asking about progress
with the Windows Search Protocol server work that I started (a long time
ago now) and also how to get a hold of the not yet integrated code to
test. With that in mind I'd like to introduce you to a a new docker
compose project.
So, if you would ever wanted to try setting up the experimental Windows
Search Protocol server and have been intimidated by the the prospect of
o downloading and building a custom version of samba with the windows
search protocol from source
o downloading and setting up and configuring either opensearch or
elasticsearch
o downloading and setting up fscrawler to index a share location
o configuring samba and ensuring the opesearch/elasticsearch, samba
and fscrawler all play together nicely
then https://gitlab.com/npower/wsp-container can help you out.
You can run a test setup (complete with a small set of test files) with
practically zero configuration see.
https://gitlab.com/npower/wsp-container#quick-start---test-mode There is
also has a fuller demo mode with some more advanced configuration examples.
Please try it out :-)
Most of the above was prompted by a more focussed attempt to provide
some documentation around the WSP server and setting things up (and
realising it is a bit tricky). Please see.
https://wiki.samba.org/index.php/WSP
Regarding progress of integration of this feature I have recently
updated all the associated merge requests to do with the windows search
protocol server support
There are now 3 merge requests
a) A merge request for the base async SMB named pipe based (but NOT
dcerpc) infrastructure to create the WSP service (or a service that uses
SMB named pipes in the same way). This replaces various other merge
requests which attempted to integrate with the existing dcerpc micro
service infrastructure which I have abandoned.
see. https://gitlab.com/samba-team/samba/-/merge_requests/4008
b) A merge request for some usability improvements for
elasticsearch/opensearch (These patches are also relevant for
spotlight/mdssvc)
o allow the share config elsaticsearch:index config to use
substitutions (e.g. form indexname based on authenticated user)
o allow elasticsearch/opensearch in additiona to anonymous
authentication use a either use configured username/password or an
apikey (elasticsearch only).
o moves some code to a new subsystem so that code can be shared
between the wsp and spotlight/mdssvc.
see. https://gitlab.com/samba-team/samba/-/merge_requests/3720
c) The Windows Search Protocol server itself, the changes here include
the other merge requests mentioned above
see. https://gitlab.com/samba-team/samba/-/merge_requests/371
Noel
More information about the samba
mailing list