From 9e264f043e639b3f349fc81a948bc614909adb38 Mon Sep 17 00:00:00 2001 From: Mike McGrail Date: Thu, 21 Sep 2023 17:11:40 -0400 Subject: [PATCH 1/3] update readme --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e278458..06241d08 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Singularity Data Lake Add-On for Splunk -The Singularity Data Lake Add-On for Splunk provides integration with [Singularity DataLake](https://www.sentinelone.com/platform/xdr-ingestion/) and [DataSet](https://www.dataset.com) by [SentinelOne](https://sentinelone.com). The key functions allow two-way integration: +The Singularity Data Lake Add-On for Splunk provides integration with [Singularity Data Lake](https://www.sentinelone.com/platform/xdr-ingestion/) and [DataSet](https://www.dataset.com) by [SentinelOne](https://sentinelone.com). The key functions allow two-way integration: - SPL custom command to query directly from the Splunk UI. - Inputs to index alerts as CIM-compliant, or any user-defined query results. - Alert action to send events from Splunk. @@ -27,16 +27,20 @@ The add-on uses Splunk encrypted secrets storage, so admins require `admin_all_o | Inputs Data Manager | Optional | For Splunk Cloud Classic Experience, if the modular inputs are used, this add-on is installed on an IDM. | ## Configuration -### Singularity DataLake +### Singularity Data Lake 1. From the SentinelOne console, ensure Enhanced Deep Visibility is enabled by clicking your name > My User > Change Deep Visibility Mode > Enhanced. ![Setting Enhanced Deep Visibility](README_images/setup_enhanced_dv.png) 2. Open Enhanced Deep Visibility. -3. Continue following the DataSet instructions below. +3. In the top left, ensure an account is selected (not `Global`) -### Dataset (and Singularity DataLake continued) -1. Make note of the URL (e.g. `https://app.scalyr.com` or `https://xdr.us1.sentinelone.net`). For SentinelOne users, note this differs from the core SentinelOne console URL. +![Selecting SentinelOne account](README_images/s1_account.png) + +4. Continue following the DataSet instructions below. + +### Dataset (and Singularity Data Lake continued) +1. Make note of the URL (e.g. `https://app.scalyr.com`, `https://xdr.us1.sentinelone.net` or `https://xdr.eu1.sentinelone.net`). For SentinelOne users, note this differs from the core SentinelOne console URL. 2. Navigate to API Keys. ![Creating DataSet API keys](README_images/dataset_key.png) @@ -53,7 +57,7 @@ The add-on uses Splunk encrypted secrets storage, so admins require `admin_all_o 2. On the configuration > account tab: - Click Add - Enter a user-friendly account name. For multiple accounts, the account name can be used in queries (more details below). -- Enter the full URL noted above (e.g.: `https://app.scalyr.com` or `https://xdr.us1.sentinelone.net`). +- Enter the full URL noted above (e.g.: `https://app.scalyr.com`, `https://xdr.us1.sentinelone.net` or `https://xdr.eu1.sentinelone.net`). - Enter the DataSet read key from above (required for searching) - Enter the DataSet write key from above (only required for alert actions). - Click Save From 85a8b0d373ba73d52060a18f38eb12bd82a7f47b Mon Sep 17 00:00:00 2001 From: Mike McGrail Date: Thu, 21 Sep 2023 17:11:47 -0400 Subject: [PATCH 2/3] add image to select account --- README_images/s1_account.png | Bin 0 -> 9678 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 README_images/s1_account.png diff --git a/README_images/s1_account.png b/README_images/s1_account.png new file mode 100644 index 0000000000000000000000000000000000000000..13fcde238f35bf567f91283e943a0d253fb71874 GIT binary patch literal 9678 zcmeHsXIN8B&?qR1H0e!BC?YikP!Xw05kUw|AkBk1398jPu)vVVyp|FJ!NTQd4~V%$d_)!)fx%Vxrxj z2h@3-m{#lQBNowT<8SL=qEL1DH~Iv%B9d`A@91ukgiGVIWWEuUg}6^{{b)gcqz+l? zl>pxQA3xVxujkoEZAJRSutE$*Wmry&@n|j(?f@k$I0h^NJMeY=}Kr8 z^~=S`PpzEhynG`VL-TaKwd;zeP<#FfwJ;}hT8BYJt3>Q0iCbz#(PpPD)&>(=B&)_e zHPb^W-p`94+*#5Fza0p^P(S?1nnNk|byH;ZM-iIMGE%O>mQ!hRRr2RYd0Xhw0Cdph z7rD+QXnaka{N=iM=C^e{*U@| zBqR|IBxHZ}fdcv2lL(|Um_PILufj>lfjVpJuOf{@$|ll2MGy_z*!>I(7*Z%z(4Hp5atQf){?b#br!dNf&!`9v5si%Xh3(px|Ya3TDPX#`{vw{A3{-hJ(hgLV6!5nJmepd zDN@Q*KRa7>oDQlw4}lz5V}Cpnz*h)JXE~7QTh;W#?0`I0L-p=MAJX+~lSnSZD;Uv! zHu^ZK_<1RtfTudDs^7^{Fu=)f9mnEcL$9AIC+HsRM*Ru zgh=0oxLmz+?%!9UgsjVFi>aX9k8&l8?EbUAUlKAQEnlug5{iG`nh=sO2T|zxP##i- zf8I9|i#Pv^?g!;Lrh-x#8tRb05uIUdOCJ3XqQpC*mvqxmb2lU|{fmf)l+wWR{J(VF zIakVa$9g<^u$AXuqMn@*Me`3uK;eIh0$BF{!YQu&(blFDjFXAD{M0zkRL0;x)-0R&+@}otOJokP|<${pJcJ7?yIk!ek;C1^%kvDXhBs zp5nBk=h542soVlmLkhQsPr-pBs$$4_V`aM2BJ)R_-AFo_g+!IA^y~I^h1p0`Byk&K zAHju$q43lG_O_V#@5uGBm(EiSHwkkwkg5d5BO(9Y@3*Q)E&ag+Tygn0y?h?9LD;0u z)xK~LBEzX_xS2*69k<9ONyJ%1@N1_jCo5NUqJo_d%@(x~=|W+Np)}2V$~)#*~A!wre{+Mk7qB|8*u8?vbkk!3w&mUQv zdZ!GvRaOVoI4vrUdC6r;)Y`49XGnD3)H8g4Y~hjyIYzY^8PWM89I^O^#EZT?$VM|s%}i=&-1rzBg@EI-2Nc5E0XROe?nhszi4 zVB$8>_Q=w=9dlf5_x)RrAFjwU{XG{0&vO=r`wRssD=*D?Zm^0s)Xnn>{>HE<#`4=1 z^vM+Gp@*uSpslj%{Cf!`^m#i|db<7a3+&EqHD7z|2h&GBGejEBdDau9PeGk8wJF5R z>m@R;+d~IuU(d6EO_RT8%hgqZ@q|>}k+TNrsQ3m^}>3M%bd{j7)F8DUZKE@N#y%oI*RrJx?FQzQ;?|tv)8$qXEL~ z3+|9 z#Gz@CK?t3(?3fYd@ZbDYm??#bZag_!n;JHTZ$M>NuhwC>{cA+J8b0wAMsWLmY2NuJ zx*086_SjIo*r?Qfs~K;3(y%vTmSoGJ6x1ZQ-N86jJ8HRB)_@aPPK9^?yW{~kJe8L) z8bm7sqGKfWa+#~3Z}}Zn<+AfOuvjOZPS{aJY#cpZNA@7S^dm}S!u08Ci=PtmvL`4; z=Zh{L)FW@Zol-f#Su*D7&q&~nNuwEZgjNQMvU1rvnHvVC|9bID#edxp!LcFfW~|QB z7B7&M-<$DyJ!~e8hH`KR|0{Xz-Gm~f`L{k;@91c)d=v*-qef44O~-5pDH!2b@)9!U zCY5Ryjmped<8Lpe8FiT6ni0$ms5*c8dv(w(2?H?6tYgXenNXZ#-4xPece&4-L)z)- zM4c<7>nk)k80~+0jGtP^R%gS_>V}Lg!q?#hg^zyEycq9UKwLUxtScCgE`_O%O@DWL zY$kq1G~R`1RWf$ZM4;Xi-V9>YYe--wJY96?)bFIXy_zcmmE=Y!im{}CigP;z5Mt?OSL;pT>hKnLmi zyYn2~Sb7M2)$un&y*1h+BCFxw7`K=;&#LMDP zE^-_f)XGSl4VAO>q?QO(G|UXDGCK-K>A7~kAug9f=R@W~wuFa-$O~p-y&ofvN*pB@ z~U?{z3PFSp4QIHM3p01YyDTj~$r!FP8 zsZ5AYjNbmDNW^r(vLvAxRt~emmd)5lADw%|aoBs8`o}nl zYuuQbBm=CEBxBD_L(sR_qJx#r9^pAUe-)FQ;FCix3V-_LrqrjQgp~p%Jb|3bO?X&|6ubJS}X1SF&q0vDDxd{9g7c=!BC(P!q%YrZh z8#mE_jhJiQ=@+$ra#+qUT{89_+Fr+&;`XvqSh?pL@1w_iMM;Is=+}jdg0X7u)tcQ2 z03X_`9EVL>5)IbJUj?)eR82WsX!YDZxXElQnW?@0I!di(mDspVWmdU8RqJ)u8gu)u#$?w^A`8FM0sdeu&Jn=M?{9oAG^Js+AT#KkjLMO$!stK0oamY$uH03{!ANVv ziimc8kOgyl(&(pjEt#%*b96|jrv;V$s&Lp|VyA}qV%Y%0y=m;GIZHnt%Y|_=**5i^ zJ^}(dYC|*%1^b#Z8mNxE-T4;U$^h|By2X8r?Ud4 z$l~kGR}aM9PWW+6v^gRe>dlY~R9UC635%e^#m%3gw9*(t0@?$_KuiIf?Xau#T$#%U z4awp@DM#)sf)#G<$tQ^DRedd(7Ic&v2rGc=yVXDU=TOS$z1mQLNUB(#4s zc=jW|d1RXiDNC2z%G(H8G5<%-be6DQAB^0i7O7u8s{lT9gKNoboXRL5_CU|eyIGe?N{2t>) zHaNh!rq|QIwww1&P{I9btgCM?i!$C1mS+;+NCWx&eC~3%v#4*F42vTbz0hIzICDwN zEq130%faC?;M3`XtGC8jvgN%sy+y1@KoqmK4Kdt)>&oTmH1my@3CtoI8-q>u6Ycte zT2$(3w-Hj*@3!pJUn-9_(4}13^wnN7fThi zw6qZYW5>UsoF^`d*^`l$*bcQZ&1toWe%$z?NH#zrn57#FM>(b6Q0urm#J!Ekq>r@$1x>Emim;-54#>)Q<59rwq1gCX=1f|ZETZMn*%-C zwYhJtjm4RF&>vC2id~~W3`lnv!HlqFPiQwf<89~e;maA!8_K73DlJ||Aow4Z1a|F% z<+N4ZdlYfSGWi|4b~8_kcO159c2VonrJ{_1Z*{5c1-k>fI^c{ijah8jRHESv^h_c|I41r1Lr3lDA``(=mODgc7z8f#?PD z^S>nGgG11CS!r<{>bO^VECmuI+fiN*?R(N@i3Yoe)VVpeLu<`*Yosf?lOBD{E!%pE zxP|<{{NA)^$pGs3Eh02W9{WAxX1DWXyzY z{v@>TFo)}=wb7T629%zo+Or)YX1cZr6J4j9u&X9ZE*{Xh;H!9o5)hg>J#}!aq9P%o zojHrkY-F2#FdV*uNqq&oXFAef#jpQDQ{e8NF6^<;Ld;PH?T7(iGHpc2)!&g0s$&=U z8+a(?{A30U?m{q4p8AanWQb%n&yaOxJXM%UZ}mycE)DwT{;egp-Ku>{kImDNPBxEt z$(C+c>SdzbXqJb!Y&KN-%a+nD*RRlQc?DeKqp$kQqqyB~E$7R)wmY3(xJP2|ake&tNe(MGq6p>TrwMMB)H^stsGq?t7wM$4I)3= zu3yCF*vb!^59VU3j|uqYF2Yi#s~r`q_})@AUK)3buue(0JiJa#3^9%+9h4n##JZml_(ioc)fNk&+ri2OsQE0l|0?4ZBctw z2gR8Z^DnV?U+hp7i?2f2B9D;|#(3&mYGP6L!en3vkCA(Cn$5R2NMDTvEfd`<=K2=mxZ$ zp7;lzfDOw`Z|3VzR-_u0OylCp%x8r ze|pb%qjuCB1WyBaJ5~Gjz<;ZGG)@iC70VtNc#&5NuP6us6M>@}QZn2p(`_=BkZ!W_o z!47>&Z&s6PBURQ#Uj_7pd(GhkBV8><1hh&I^qm|p3fp|$$-9tAk;51xdc+g{4rP06KnBlw{NU3&m@1Fyc9#t`#pJu7UE+%X*tR?T zWV=}eWF93#D0-0G7Mw0>W9Xs7j&@)CwhmB=2sq3d{CDeJPjl?r6#Lz2ShChIyki1Ps^ir&+{_A?anUU^VG z%G}62r^}(-_zp&$-`1bjtGfO0S5E++%;gj~)nCoFj5n3HsMpf8G1VzOw0`E>%~;@% z-}DO5`&`OWjT0mk!wHyO%S@yyQ z&h62p1bwGGxMhj3GFj!y*!!~issO9pP21s8PAfRR_6UY54PtP#@HJH|fq4=eT-*jK z^D9R7zm1g2w`yYaM^H-QI!>l@;H$p_=+_8eIU=Ojio@(Jr=ksr5yYjqC<`u@39;RT z+0X@#)%?``>{bJ5983PMD4C1t_RJH2GgQ|e5>Zp2ojDS-S6VmiPVnBGG!Z(HzGNU# z+D0Pi$p9elPB9w3<5xCRF6{nj&#b1-zAc$C@q;$!yB=UYFSlHw;T1Cxof1^W0Z?`t*G$gJLEjOI;AMZG-^!}0pRJwf1?qx3JycDrcRyq&tj$`I)ray=ic zW5pMrI5So+0SZM*JKZ$nvSHoaUHC`W-b50s5GW3==;slNB;ZkUtOBE zyR4`oO}|2@Sn;Ns0c?V~I!ebkG;VwyLtPpap>E~VNqfhIug3MY1QOg&8AAoPW&l?~ z;p#+7U}NU>u@Vuj;w3T1H;agI(ryN-w~XFSXxbZUUtrQ|Oh@~_ktoe+eWQ&$`h-?s-u9X(#LZc5mB z0l#n624(MO0cI%KF>W)*P#I1%VvnicIe?XXf^7J}UkpYwiylE2Drr91m_`VNK@K1c zt`>oXTImD+Fbc_^nnGmcWhJxR`T?vE%dA7C`7?7@d_*mV1yKmiZu>QDKU!vyXW99} zpKA+n;?Df$-k&-)?ywg>E0y_chECOV7!OF!Cm0B!7|m1g<$^98Ii zJW#-4Uvtv6!EL_F30s9=FN>eMn{VdYe6!uJL!tG^gLtq_O{-7goopE9Fr4Kj1}-ZE zeGvQnlPYZtC2$Q)|1(CUyA08t`+;e~FLrol2TXY6bYDzE?wc;C((t`%77#+K>ysE! z>O;rUEb?p!#dN*HymKkNt^_aEu_Qj;Jzj7&yUkSl(jGp((}6JTw~M2t=tw)L8MhWS zWD6&nN>XwN&$jPC2=77NzioY|N}|ngc1D4Wp=$@R%fkbSJb)UWAy_6{^_{ckgfGYg zzRkd-s1o4l=UnO}Jjewc=9b*#y}n~FKta2roBQyUwwS8r9RD&ruGF!-d4vl>F055~ zxm&7rEKNc!H`Aq|2!A~YUPZx?1~I3{pO!vkE->`ipLbYAR)(6ayx?NIpr-a}W~NH% zlC?-u7GFROOq1TJ!XhQNcgCKv%5g7=_+Bfj@NrJc_hi`BYcb97q{qrlHw7*5m>5WL z&0It&pR`!xNsGK5CGRr64rTl9J8L}eb0I!Rz8K$qfu+P5CTmI#uZmYN7>nFe;jacD z=;v=t!`O?j_4;h6d7vHTsvEdjKY!Wa#gRq}5a?$wOFne_nWKI@Sf&I;Z8yB*aFOxw zhjO(sLE1(k7*@E@Oc22tKX7oDYOspBRSJj&gWLo6vG!ikpJhjeHXV!xswivVU&=al zjYZK~*id&xb6J?W9Z`D)|JgngXs}b`l;3p@&cZP^evC+mrFSMcV2LK-Pl~=LVE-)zS)#=b)FIjcrbqDsRQ#k zx`K)b)_(qbhd&d}-$@pSw@h-ml7qDb%HL5-h#RIw)5_EBEhOp0+r%l6JX4B)Ry=T| zL?Q)E^}1wGX?)F|ePYRd;52ECWmwVT^Bi^45suf`)j(}IvdJ^&vH#)>`MrEO1a3i( z5FV&*nbXeg&$aD!VMFNp1j=0J~>r z)?tT2y0oKqT<5TUS(IHVMXzz?VH#xm%wu&N)7d{qmvh3QrT|FTW50&)S+Vfv*j1 ze;(l0WPayTQ4ZpqJ}C-vtH`H4{Oxd@m>8D59rPp0(PysIy7#dD`(gcUZd|c0?@K=8 zetk{K47*aWBlLE}_Y9Ss`{AxFzfAM1&N0t-ttsT2KWMK@kr8CHgI?2m_f@(6vL5A2 z6}`c%TILLoUTcq~M8VS898n@xm&l|fB{kq5!Ud5{%_ZpBaOj}&xQ@dQ`(oWoY4E1= z#2fxWPy9vDjdZ5FtI;oem$c197TXK!MQ1s7KTnF&3@ z8vAaq{JS=209=(|jLoQp`qb8#?B3LiSLsPwd*%4d(TcB()KYSzx8WqY+4Kk(e0i_O zY2xJ03_-irc_bp~&f{L+T2Gnf7`>N&Tn5&p0(aB?%PHx9{+`_s-^l|mnWdjJu!;TW j3j2S%{r}65)>D$C*M##{^(k1u=O@ungQ}J(TZQ}&*0u*C literal 0 HcmV?d00001 From af56d24d53e35c44a9880fe691c385e95186c940 Mon Sep 17 00:00:00 2001 From: Mike McGrail Date: Thu, 21 Sep 2023 17:16:36 -0400 Subject: [PATCH 3/3] clarify support through official channel --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 06241d08..454250e6 100644 --- a/README.md +++ b/README.md @@ -174,13 +174,15 @@ For use cases requiring data indexed in Splunk, optional inputs are provided uti An alert action allows sending an event to the DataSet [addEvents API](https://app.scalyr.com/help/api#addEvents). ## Support and troubleshooting +SentinelOne Data Lake users are able to see meta logs, such as search actions, but no endpoint data in Splunk - Ensure the read API token was provisioned from an account, not Global. + Error saving configuration "CSRF validation failed" - This is a Splunk browser issue; try reloading the page, using a private window or clearing cache and cookies then retrying. Search errors `Account token error, review search log for details` or `Splunk configuration error, see search log for details.` - API token was unable to be retrieved. Common issues include user role missing list_storage_passwords permission, API token not set or incorrect account name given that has not been configured. Review job inspector search log for errors returned by Splunk. `Error retrieving account settings, error = UrlEncoded('broken')` indicates a likely misconfigured or incorrect account name; `splunklib.binding.HTTPError: HTTP 403 Forbidden -- You (user=username) do not have permission to perform this operation (requires capability: list_storage_passwords OR admin_all_objects)` indicates missing Splunk user permissions (list_storage_passwords). To troubleshoot the custom command, check the Job Inspector search log, also available in the internal index: `index=_internal app="TA_dataset" sourcetype=splunk_search_messages`. -For support, open a ticket with DataSet (or SentinelOne for XDR) support including any logged errors, or open a GitHub issue. +For support, open a ticket with SentinelOne or DataSet support, including any logged errors. ## Additional Notes Though not typically an issue for users, DataSet does have [API rate limiting](https://app.scalyr.com/help/api#rateLimiting). If issues are encountered, open a case with support to review and potentially increase limits.